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": "famous@youverify.co",
"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": "developer@youverify.co",
"mobile": "+2348036208556",
"countryCode": "NG",
"id": "61d880f2e8e15aaf24558f9b"
}
},
"links": []
}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": "famous@youverify.co",
"mobile": "08030000000"
},
"agent": {
"firstName": "Ann",
"middleName": "Kyle",
"lastName": "Chandler",
"signature": "https://cdn.youverify.co/1645718144237-kdLVxJOwjRRBgsilqVIft.jpg",
"photo": "https://cdn.youverify.co/1645736269355-u2htGCP6_vELUWtLCnTmm.png"
},
"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": "completed",
"taskStatus": "VERIFIED",
"subjectConsent": "true",
"startDate": "2022-06-01T00:00:00.000Z",
"endDate": "2022-06-03T00:00:00.000Z",
"submittedAt": "2022-06-01T10:10:32.000Z",
"executionDate": "2022-06-01T10:10:32.000Z",
"completedAt": "2022-06-01T10:10:32.000Z",
"acceptedAt": "2022-06-01T10:10:32.000Z",
"revalidationDate": "2022-08-30T00:00:00.000Z",
"notes": [
{
"createdAt": "2022-06-01T10:10:3232+00:00",
"note": "Candidate resides at 350 Borno way Yaba Lagos, Nigeria. It is a Terraced house painted Purple with Purple gate. Address and candidate was confirmed by the Maid"
}
],
"isFlagged": false,
"agentSubmittedLongitude": "3.3755177",
"agentSubmittedLatitude": "6.8060262",
"reportGeolocationUrl": "https://www.google.com/maps/search/?api=1&query=6.8060262,3.3755177",
"mapAddressUrl": "https://www.google.com/maps/search/?api=1&query=350%20Borno%20way%20Yaba%20Lagos%20Nigeria",
"submissionDistanceInMeters": 655,
"reasons": null,
"signature": "https://cdn.youverify.co/1645718144237-kdLVxJOwjRRBgsilqVIft.jpg",
"images": [
{
"filePath": "https://cdn.youverify.co/1645724384664-N7EfKFG7xjdp6K73LgBK3.jpg",
"fileType": "image/jpg",
"height": 300,
"width": 400
}
],
"buildingType": "Terraced house",
"buildingColor": "Purple",
"gatePresent": true,
"gateColor": "Purple",
"availabilityConfirmedBy": "Maid",
"closestLandmark": "Southern Company",
"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:10:32.864Z",
"_createdAt": "2022-06-01T11:03:3737+01:00",
"_lastModifiedAt": "2022-06-01T11:10:3232+01:00",
"verificationId": "6297396cc0dea",
"id": "62973964fdc2225c65bb1303",
"user": {
"firstName": "Famous",
"lastName": "Ehichioya",
"middleName": "Prior",
"email": "developer@youverify.co",
"mobile": "+2348036208556",
"countryCode": "NG",
"id": "61d880f2e8e15aaf24558f9b"
}
},
"links": []
}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": "famous@youverify.co",
"mobile": "08030000000"
},
"agent": {
"firstName": "Joe",
"middleName": "Luella",
"lastName": "McGuire",
"signature": "https://cdn.youverify.co/1645718144237-kdLVxJOwjRRBgsilqVIft.jpg",
"photo": "https://cdn.youverify.co/1645736269355-u2htGCP6_vELUWtLCnTmm.png"
},
"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": "canceled",
"taskStatus": "PENDING",
"subjectConsent": "true",
"startDate": "2022-06-01T00:00:00.000Z",
"endDate": "2022-06-03T00:00:00.000Z",
"submittedAt": null,
"executionDate": null,
"completedAt": null,
"acceptedAt": "2022-06-01T10:12:02.000Z",
"revalidationDate": "2022-08-30T00:00:00.000Z",
"notes": [],
"isFlagged": false,
"agentSubmittedLongitude": "3.2560208",
"agentSubmittedLatitude": "6.7201887",
"reportGeolocationUrl": "https://www.google.com/maps/search/?api=1&query=6.490806, 3.3808834",
"mapAddressUrl": "https://www.google.com/maps/search/?api=1&query=350%20Borno%20way%20Yaba%20Lagos%20Nigeria",
"submissionDistanceInMeters": 1696,
"reasons": "Invalid Address",
"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:12:02.444Z",
"_createdAt": "2022-06-01T11:03:3737+01:00",
"_lastModifiedAt": "2022-06-01T11:12:022+01:00",
"verificationId": "6297396cc0dea",
"id": "62973964fdc2225c65bb1303",
"user": {
"firstName": "Famous",
"lastName": "Ehichioya",
"middleName": "Prior",
"email": "developer@youverify.co",
"mobile": "+2348036208556",
"countryCode": "NG",
"id": "61d880f2e8e15aaf24558f9b"
}
},
"links": []
}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": "famous@youverify.co",
"mobile": "08030000000"
},
"agent": {
"firstName": "Jerome",
"middleName": "Travis",
"lastName": "Lawrence",
"signature": "https://cdn.youverify.co/1645718144237-kdLVxJOwjRRBgsilqVIft.jpg",
"photo": "https://cdn.youverify.co/1645736269355-u2htGCP6_vELUWtLCnTmm.png"
},
"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": "completed",
"taskStatus": "NOT_VERIFIED",
"subjectConsent": "true",
"startDate": "2022-06-01T00:00:00.000Z",
"endDate": "2022-06-03T00:00:00.000Z",
"submittedAt": "2022-06-01T10:13:05.000Z",
"executionDate": "2022-06-01T10:13:05.000Z",
"completedAt": "2022-06-01T10:13:05.000Z",
"acceptedAt": "2022-06-01T10:13:05.000Z",
"revalidationDate": "2022-08-30T00:00:00.000Z",
"notes": [],
"isFlagged": false,
"agentSubmittedLongitude": "3.6355781",
"agentSubmittedLatitude": "6.5391231",
"reportGeolocationUrl": "https://www.google.com/maps/search/?api=1&query=6.490806, 3.3808834",
"mapAddressUrl": "https://www.google.com/maps/search/?api=1&query=350%20Borno%20way%20Yaba%20Lagos%20Nigeria",
"submissionDistanceInMeters": 1164,
"reasons": "Address not accessible",
"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:13:05.718Z",
"_createdAt": "2022-06-01T11:03:3737+01:00",
"_lastModifiedAt": "2022-06-01T11:13:055+01:00",
"verificationId": "6297396cc0dea",
"id": "62973964fdc2225c65bb1303",
"user": {
"firstName": "Famous",
"lastName": "Ehichioya",
"middleName": "Prior",
"email": "developer@youverify.co",
"mobile": "+2348036208556",
"countryCode": "NG",
"id": "61d880f2e8e15aaf24558f9b"
}
},
"links": []
}Last updated