VerifyMe API
  • Welcome
  • general
    • Getting Started
    • Introduction
    • Authentication
    • About Verifications
  • Identity verifications
    • Bank Verification Number (BVN)
    • Corporate Affairs Commission
    • Drivers License
    • Identity Biometrics
    • BVN Identity Matching
    • Virtual NIN (vNIN)
    • National Identification Number(NIN)
    • Tax Identification Number
    • Voters Card
  • Address Verification
  • Submit Address Verification
  • Get Address Verification By ID
  • Get Address Verifications
  • Cancel Address Verification
  • Fetch an Address By Identity
  • Business Verification
    • Submit Business Verification
    • Get Business Verification By ID
    • Get Business Verifications
    • Cancel Business Verification
  • Guarantor Verification
    • Submit Guarantor Verification
    • Get Guarantor Verifications
    • Get Guarantor Verification By ID
    • Cancel Guarantor Verification
  • employment Verification
    • Submit Employment History Verification
    • Get Employment History Verifications
    • Get Employment History Verification By ID
    • Cancel Employment History Verification
  • Property Verification
    • Submit Property Verification
  • Liveness Verification
  • LOCATION
    • Get Countries
    • Get Country By ID
    • Get State By ID
    • Get State For Country
    • Get Lga By Country
    • Get Lga By State
    • Get Lga By ID
  • Bank
    • Get Banks
    • Get Account Details
  • BVN NUBAN
    • Get Nuban Banks
    • Get BVN details by NUBAN
  • webhooks
    • About Webhooks
    • Verified Address
    • Verified Guarantor
    • Verified Employment History
    • Verified Property
  • Product statuses
  • Error Status Codes
  • Glossary
  • Widget Services
    • VerifyMe Liveness Widget
    • Requery Liveness Verification
Powered by GitBook
On this page

Was this helpful?

  1. Property Verification

Submit Property Verification

Please note that you are required to have a webhook set for property verification requests to be successful. If they are not set, you will not get notified when the verification has been completed.

Submit Property for Verification

POST https://vapi.verifyme.ng/v1/verifications/properties

This endpoint allows you to create a property verification request

Headers

Name
Type
Description

Authentication*

string

Authentication token

Request Body

Name
Type
Description

customerReference*

string

Customer reference

propertyName*

string

Property Name

propertyType*

string

Property Type

address*

string

Street

lgaName*

string

LGA

contactPerson*

object

{firstName, lastName, phone, email}

{
  "isAsset": true,
  "verificationTypeCode": "property",
  "createdAt": "2021-10-06T14:56:48.000Z",
  "updatedAt": "2021-10-06T14:56:48.000Z",
  "id": 71,
  "agentId": null,
  "applicantId": null,
  "organisationId": 1,
  "userId": 1,
  "groupId": 10,
  "statusId": 2,
  "opsStatusId": 2,
  "agentStatusCode": null,
  "agentComment": null,
  "assignedBy": null,
  "assignedAt": null,
  "approvedAt": null,
  "approvedBy": null,
  "rejectedAt": null,
  "rejectedBy": null,
  "updatedBy": null,
  "requestedAt": "2021-10-06T14:56:48.000Z",
  "consentReference": "yo0pvJLUGLy14IqRKrdHz",
  "orderNumber": null,
  "fulfillmentNumber": null,
  "agentCommission": 400,
  "requestSource": "api",
  "agentPaymentReference": null,
  "agentSubmittedAt": null,
  "archived": false,
  "timeToCompletion": 0,
  "price": 0,
  "specialPrice": 0,
  "discount": 0,
  "overrideAgentCommission": 0,
  "commissionComment": null,
  "slaHour": 24,
  "canContactPoc": false,
  "apiReference": null,
  "bundleCode": null,
  "adminComment": null,
  "stateId": 25,
  "lgaId": 500,
  "latitude": null,
  "longitude": null,
  "isVague": true,
  "customerReference": "cust-m-001",
  "paymentMethodCode": "standard",
  "verificationType": {
    "createdAt": "2021-07-27T12:48:30.000Z",
    "updatedAt": "2021-07-27T11:48:30.000Z",
    "id": 1,
    "code": "property",
    "name": "property verification",
    "description": "Property verifcation type indicated all verification types that are done for a property"
  },
  "status": {
    "id": 2,
    "code": "ops_action",
    "label": "Ops Action",
    "stateCode": "pending",
    "stateLabel": "Pending"
  },
  "opsStatus": {
    "id": 2,
    "code": "ops_action",
    "label": "Ops Action",
    "stateCode": "pending",
    "stateLabel": "Pending"
  },
  "lga": {
    "id": 500,
    "code": "LGA500",
    "name": "Agege",
    "strippedName": "agege",
    "stateId": 25,
    "state": {
      "id": 25,
      "code": "NG-LA",
      "name": "Lagos",
      "strippedName": "lagos",
      "countryId": 1
    }
  },
  "lgaName": "Agege",
  "stateName": "Lagos",
  "propertyAesthestic": {
    "hasMarksAndStains": null,
    "marksAndStainsRating": null,
    "hasMinimumOfTwoSittingRoomWindows": null,
    "hasMinimumOfTwoBedRoomWindows": null,
    "additionalComments": null
  },
  "propertyBasic": {
    "propertyType": "Apartment",
    "propertyCost": null,
    "propertyName": "Ola studio",
    "scheduleDate": null,
    "propertyPhoto1": null,
    "propertyPhoto2": null,
    "propertyPhoto3": null,
    "propertyPhoto4": null,
    "propertyPhoto5": null,
    "propertyPhoto6": null
  },
  "propertyConfirmation": {
    "numberOfBedrooms": null,
    "numberOfBathrooms": null,
    "hasClothStorageFurniture": null,
    "isSmokingAllowed": null,
    "areEventsAllowed": null,
    "areChildrenAllowed": null,
    "arePetsAllowed": null,
    "hasDryer": null,
    "hasLift": null,
    "hasHotWater": null,
    "hasTV": null,
    "hasAirConditioning": null,
    "hasFirstAidKit": null,
    "hasWashingMachine": null,
    "hasToiletries": null,
    "hasWiFi": null,
    "hasBunker": null,
    "hasSmokeDetector": null,
    "hasFireExtinguisher": null,
    "hasBreakfast": null,
    "hasTowel": null,
    "hasBedsheets": null
  },
  "propertyContactPerson": {
    "firstName": "Folarin",
    "lastName": "Adedeji",
    "phone": "+2348074567321",
    "email": "folarin@test.com"
  },
  "propertyCriterial": {
    "hasEmergencyExit": null,
    "hasWindowsBurglaryProof": null,
    "hasDoorsBurglaryProof": null,
    "areElectricWiresExposed": null,
    "additionalSafetyComment": null
  },
  "propertyLocation": {
    "hasTarredRoad": null,
    "hasParkingSpace": null,
    "availableCarSpace": null,
    "commentAboutLocation": null,
    "street": "oko oba",
    "city": null,
    "hostLivesHere": null,
    "numberOfTenants": null,
    "latitude": null,
    "longitude": null
  },
  "propertyUtilities": {
    "tapsRunWell": null,
    "hasCableTv": null,
    "hasStandbyGenerator": null,
    "hasKitchen": null,
    "hasMicrowave": null,
    "hasElectricKettle": null,
    "hasCookingStove": null,
    "hasPlatesAndCups": null,
    "hasCutlery": null,
    "additionalUtilitiesComment": null
  },
  "exteriorPhotos": {
    "exteriorPhoto1": null,
    "exteriorPhoto2": null,
    "exteriorPhoto3": null,
    "exteriorPhoto4": null,
    "exteriorPhoto5": null,
    "exteriorPhoto6": null
  },
  "slaElapse": 0,
  "isLate": false
}
{
    "status": "error",
    "message": "string",
    "code": "ACCESS_DENIED"
}

Sample Request

{
  "customerReference": "yo0pvJLUGLy14IqRKrdHz",
  "propertyName": "Landmark Apartments",
  "propertyType": "Apartment",
  "address": "Adekunle Fasasi",
  "lgaName": "Agege",
  "contactPerson": {
    "firstName": "Henry",
    "lastName": "Abu",
    "phone": "08074856213",
    "email": "henry@test.com"
  }
}
curl --location --request POST 'https://vapi.verifyme.ng/v1/assets/property' \
--header 'Authorization: Bearer <live or test key>' \
--header 'Content-Type: application/json' \
--data-raw '{
  "customerReference": "yo0pvJLUGLy14IqRKrdHz",
  "propertyName": "Landmark Apartments",
  "propertyType": "Apartment",
  "address": "Adekunle Fasasi",
  "lgaName": "Agege",
  "contactPerson": {
    "firstName": "Henry",
    "lastName": "Abu",
    "phone": "08074856213",
    "email": "henry@test.com"
  }
}'

PreviousCancel Employment History VerificationNextGet Countries

Last updated 3 years ago

Was this helpful?