Create a Capture Request

Overview

This endpoint initiates a Hover property capture by creating a draft job in your authenticated organization and sending an invitation (via email/SMS) to a designated user to perform the capture.

When this endpoint is successfully called, a new draft job is immediately created within your Hover account. Simultaneously, an invitation is sent to the specified capturing_user_email (and optionally capturing_user_phone) prompting them to download the Hover app and capture the property.

All parameters provided within the job_attributes object will be used to pre-populate the details of the newly created draft job, minimizing manual entry for the capturing user.

Required Body Parameters

The following parameters are required in the request body. Providing additional job_attributes is highly recommended to pre-populate the resulting job with more data. While the capturing_user_phone is not required, it is recommended so that the assigned person receives a SMS text message to prompt them to download the Hover app.

Parameter	Type	Description	Required
`capture_request[capturing_user_name]`	`string`	The full name of the user who will be prompted to capture the property.	Yes
`capture_request[capturing_user_email]`	`string`	The email address of the user who will be prompted to capture the property. An invitation email will be sent to this address.	Yes
`capture_request[job_attributes][location_line_1]`	`string`	The street address of the property to be captured. This is a minimum required attribute for the draft job's location. Additional `job_attributes` (e.g., `location_city`, `location_state`, etc.) can be included for more detailed pre-population.	Yes
`current_user_email`	`string`	One of `current_user_email` or `current_user_id` is required. The email address of the user within the authenticated organization who is initiating this capture request.	Yes (or `current_user_id`)
`current_user_id`	`string`	One of `current_user_email` or `current_user_id` is required. The ID of the user within the authenticated organization who is initiating this capture request.	Yes (or `current_user_email`)
`capture_request[capturing_user_phone]`	`string`	Optional. The phone number of the user who will be prompted to capture the property. If provided, an SMS invitation with the capture link will be sent to this number. Highly recommended to ensure the user receives the mobile prompt.	No

Sample Request Body

{
    "capture_request": {
        "capturing_user_email": "[email protected]",
        "capturing_user_phone": "5558675309",
        "capturing_user_name": "Lucille Bluth",
        "signup_type": "homeowner",
        "job_attributes": {
            "deliverable_id": 3,
            "external_identifer": "Claim1234",
            "name": "The Big House",
            "location_line_1": "1701 Bryant Street",
            "location_line_2": "",
            "location_city": "Denver",
            "location_region": "CO",
            "location_postal_code": "80204",
            "suppress_email": false,
            "wallet_id": "56988"
        }
    },
    "current_user_id": {{current_user_id}}
}

Sample Response Body

When successful, this endpoint will return a 201 Created HTTP code and a response body that looks similar to this:

{
    "id": 1521803,
    "capturing_user_name": "Lucille Bluth",
    "capturing_user_phone": "5558675309",
    "capturing_user_email": "[email protected]",
    "capturing_user_id": null,
    "requesting_user_id": 1153372,
    "identifier": "XcUUtA",
    "claim_number": null,
    "state": "new",
    "signup_type": "homeowner",
    "inspection_workflow_id": 1072,
    "requires_reconstruction_capture": true,
    "job_attributes": {
        "name": "Vacation Home",
        "location_line_1": "123 Hover Way",
        "location_line_2": "Apartment 22",
        "location_city": "Los Angeles",
        "location_region": "CA",
        "location_postal_code": "90210",
        "external_identifier": "8675309",
        "deliverable_id": 3,
        "client_identifier": "0eb6edb9-b425-4797-8161-18aebf225707"
    },
    "captured_user_id": null,
    "pending_job_id": 10168587,
    "requesting_user": {
        "name": "Integration user",
        "email": "[email protected]",
        "org": {
            "id": 55342,
            "name": "Bluth Company",
            "preferences": {
                "external_identifier_label": "Lead Number",
                "external_identifier_required": false
            }
        }
    },
    "org_id": 492855,
    "wallet": {
        "id": 492767,
        "org": {
            "customer_display_name": "Bluth Company"
        }
    }
}