Retrieve an Address Verification
This endpoint allows you to retrieve an address verification report
GET
{{baseurl}}/v2/api/addresses/:addressId
Headers
Name
Type
Description
token*
String
API secret token
HTTP/1.1 200 OK
{
"success": true,
"statusCode": 200,
"message": "Address retrieved successfully!",
"data": {
"candidate": {
"candidateId": "62973912fdc2225c65bb1302",
"firstName": "John",
"middleName": "Michael",
"lastName": "Doe",
"photo": "https://youverify-api-bucket.nyc3.digitaloceanspaces.com/reports/live_photos/2022-06-01/photo_6297396bc723f8246.png",
"email": "[email protected]",
"mobile": "08030000000"
},
"agent": {
"firstName": null,
"middleName": null,
"lastName": null,
"signature": null,
"photo": null
},
"address": {
"latlong": {
"lat": "6.500871399999999",
"lon": "3.3765867"
},
"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": "6297396cc0dea",
"parentId": null,
"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",
"reportId": "reports_f1b762e8-c65b-4efa-9e6c-4aad8f258013",
"downloadUrl": null,
"apiVersion": "v2",
"businessType": "admin",
"businessId": "61d880f1e8e15aaf24558f1a",
"userId": "61d880f2e8e15aaf24558f9b",
"type": "individual",
"metadata": {},
"createdAt": "2022-06-01T10:03:37.110Z",
"lastModifiedAt": "2022-06-01T10:03:37.110Z",
"_createdAt": "2022-06-01T11:03:3737+01:00",
"_lastModifiedAt": "2022-06-01T11:03:3737+01:00",
"verificationId": "6297396cc0dea",
"id": "62973964fdc2225c65bb1303",
"user": {
"firstName": "Famous",
"lastName": "Ehichioya",
"middleName": "Prior",
"email": "[email protected]",
"mobile": "+2348036208556",
"countryCode": "NG",
"id": "61d880f2e8e15aaf24558f9b"
}
},
"links": []
}
Last updated
Was this helpful?