Webhook
ADDRESS RESPONSE PAYLOAD
Webhook responses. Supported events are address.completed
GET
api.youverify.co{
"event": "address.completed",
"apiVersion": "v1",
"data": {
"id": "reports_4768505a-f96b-42f0-a53e-310aada37a81",
"addressId": "620865980972f71ec8caf080",
"report": {
"id": "reports_4768505a-f96b-42f0-a53e-310aada37a81",
"reference_id": "620865a2cae6f",
"subject_consent": true,
"candidate": {
"id": "8eaf7f1e-c162-4c5d-a21d-1364d3ee3c54",
"reference_id": "YV620861aa450385495",
"name": "Ehichioya Prior Famous",
"first_name": "John",
"last_name": "Doe",
"middle_name": "James",
"email": "john.doe@gmail.com",
"mobile": "08030000000",
"has_live_photo": true,
"live_photo_path": "https://youverify-api-bucket.nyc3.digitaloceanspaces.com/reports/live_photos/2022-02-13/photo_620845a0edc7b3471.jpg"
},
"start_time": "2022-02-13",
"end_time": "2022-02-13",
"execution_date": "2022-02-13 03:20:03",
"submitted_at": "2022-02-13 03:20:03",
"completed_at": "2022-02-13 03:20:03",
"accepted_at": "2022-01-06 08:47:27",
"revalidation_date": "2022-05-13",
"status": "completed",
"task_status": "VERIFIED",
"reason": null,
"task_created_by": "Chinook Devops",
"package": "live_photo",
"download_url": "https://api.staging.youverify.co/v1/reports/reports_4702505a-e96b-42f0-a53e-310aada37a81/download/pdf",
"description": "Verify the candidate",
"package_name": "Live Photo Address Verification",
"details": {
"uuid": "bd0d9d95-a1c5-42e2-9c01-8c57994d70d8",
"address_id": 20336,
"candidate_id": 4735232,
"photo_url": "https://youverify-api-bucket.nyc3.digitaloceanspaces.com/reports/live_photos/2022-02-13/photo_620845a0edc7b3471.jpg",
"status": "VERIFIED",
"reason_for_fail": null,
"deleted_at": null,
"created_at": "2022-02-13 02:57:53",
"updated_at": "2022-02-13 03:20:03",
"images": [
{
"id": 5267,
"uuid": "3a2cf7e9-4c07-447c-a11d-9051640a7950",
"live_photo_id": 5261,
"candidate_id": 4735232,
"image_type": "image/jpeg",
"image_extension": "jpg",
"path": "https://youverify-api-bucket.nyc3.digitaloceanspaces.com/reports/live_photos/2022-02-13/photo_620845a0edc7b3471.jpg",
"image_name": "photo_6208659ed93ca1369.jpg",
"deleted_at": null,
"created_at": "2022-02-13 02:57:54",
"updated_at": "2022-02-13 02:57:54",
"image_path": "https://youverify-api-bucket.nyc3.digitaloceanspaces.com/reports/live_photos/2022-02-13/photo_620845a0edc7b3471.jpg"
}
],
"address": {
"uuid": "7fc780d5-426e-45a5-a341-8774c470f36a",
"user_id": 1,
"user_type": "partner",
"candidate_id": 4735232,
"flat_number": "1st floor",
"building_name": "Sum house",
"building_number": "350",
"sub_street": "Hughes avenue",
"street": "Borno way",
"landmark": "Police Station",
"state": "lagos",
"city": "Yaba",
"post_code": null,
"country": "Nigeria",
"longitude": "3.376612",
"latitude": "6.5009833",
"what3words": "",
"what3words_map": "",
"agent_geo": null,
"start_date": null,
"end_date": null,
"status": "PENDING",
"reason_for_fail": null,
"item_id": "0",
"item_type": "live_photo",
"created_at": "2022-02-13 02:57:48",
"updated_at": "2022-02-13 02:57:48",
"formatted": "Flat Number 1st Floor, Sum House, 350, Sub Street Hughes Avenue, Borno Way Street, Police Station, Yaba, Lagos, Nigeria, ",
"map_format": "350 Borno Way, Yaba , Lagos, Nigeria",
"map_address_url": null,
"map_geolocation_url": null
},
"live_photos": {
"photo_url": "https://youverify-api-bucket.nyc3.digitaloceanspaces.com/reports/live_photos/2022-02-13/photo_620845a0edc7b3471.jpg"
}
},
"has_address": true,
"notes": [
{
"id": 230,
"report_id": 1370855,
"agent_id": 2,
"note": "Candidate resides at Flat Number 1st Floor, Sum House, 350, Sub Street Hughes Avenue, Borno Way Street, Police Station, Yaba, Lagos, Nigeria, . It is a Terraced house painted black with a yellow gate. Address and candidate was confirmed by the Nearby retailer",
"created_at": "2022-02-13 03:20:02",
"updated_at": "2022-02-13 03:20:02",
"formatted_time": "13 Feb, 2022 03:20:am"
}
],
"signature": [
"/9j/4AAQSkZJRgABAQAAAQABAAD/2wBDAAEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBA"],
"is_flagged": 1,
"awaiting_qa": false,
"reportable_id": "bd0d9d95-a1c5-42e2-9c01-8c57994d70d8",
"created_at": "2022-02-13 02:57:55",
"last_updated_at": "2022-02-13 03:20:08",
"what3words": "NULL",
"what3words_map_link": "NULL",
"digital_address_code": "NULL",
"digital_address_url": "NULL",
"map_address_url": "https://www.google.com/maps/search/?api=1&query=350+Borno+Way%2C+Yaba+%2C+Lagos%2C+Nigeria",
"map_geolocation_url": "https://www.google.com/maps/search/?api=1&query=6.490806, 3.3808834",
"report_geolocation_url": "https://www.google.com/maps/search/?api=1&query=6.490806, 3.3808834",
"report_longitude": "3.380884",
"report_latitude": "6.490806",
"can_view_report": true,
"business": "Youverify",
"reasons_for_failure": [
"Address does not exist",
"Address not accessible",
"Candidate does not live there",
"Incorrect Address",
"Nobody to confirm candidate lives at the address"
],
"submission_distance_in_meters": 1226,
"building_type": "Terraced house",
"building_color": "black",
"gate_present": 1,
"gate_color": "yellow",
"availability_confirmed_by": "Nearby retailer",
"closest_landmark": "House",
"additional_info": null,
"report_agent_access": null,
"incident_report": null,
"images": {
"data": [
{
"id": 475,
"file_type": "image/jpg",
"file_extension": "jpg",
"file_name": "1644718659252.jpg",
"file_size": "1209498",
"file_path": "https://youverify-api-bucket.nyc3.digitaloceanspaces.com/reports/files/images/resize/2022-02-13/1644718659252.jpg",
"report_file_type": "report_image",
"original_file_path": "https://youverify-api-bucket.nyc3.digitaloceanspaces.com/reports/files/images/resize/2022-02-13/1644718659252.jpg",
"resize_file_path": "https://youverify-api-bucket.nyc3.digitaloceanspaces.com/reports/files/images/resize/2022-02-13/1644718659252.jpg",
"src": "https://youverify-api-bucket.nyc3.digitaloceanspaces.com/reports/files/images/resize/2022-02-13/1644718659252.jpg",
"h": 300,
"w": 400,
"resize_height": 300,
"resize_width": 400
}
]
},
"active_agent": {
"data": {
"id": "6cdab9b8-4a3e-41a0-ab70-770f09dd1525",
"last_name": "Doe",
"first_name": "John",
"name": "Doe John",
"image": "https://api.staging.youverify.co/uploads/agents/images/c086491bf8e74bd1fc06d9e2949408e6f957249.jpg",
"created_at": "2017-11-16 14:32:43",
}
},
"apiVersion": "v1"
},
"status": "completed",
"task_status": "VERIFIED",
"package_name": "Live Photo Address Verification",
"package": "live_photo",
"is_flagged": 1
}
}Last updated