Retrieving Capture Request Links

What is a Capture Request link?

A Capture Request Link is the link that you can send to a customer or other party to begin the capture process. Users receive this link when a Capture Request is created via both email, and text message (this can be turned off if your organization would like to send the link).

What is it linking to?

If you access this link from a mobile device (Fig. A), it will take you to the Hover app, or to download the Hover app. Once you open the Hover app, any details input during the Capture Request creation will be pre-populated (Fig. B).

Fig A. Link in a mobile text message (SMS).

Fig. B This is the screen a user sees when they open the Hover app.

If you access this link from a Desktop, it will take you to a page (Fig. C) that allows you to send yourself an SMS to receive the link on your phone (Fig. A). Hover captures must happen via a mobile device.

Figure A. Capture Request Link page — Fig. C Capture Request Link page

How to obtain a link to a Capture Request

Create a new Capture Request via the API and store the identifier from the response.
GET the Capture Request Link by hitting the endpoint for Capture Request Links...api/v2/capture_requests/<capture_request_identifier>with the identifier as the last parameter of the query.
The response from the API will be in an HTML format, with the Capture Request Link in the href tag. This is your Capture Request Link, and can be shared with customers as such.
1. Note: The Capture Request Link is also passed back in this reponse via the Location header, and can be obtained from that part of the response as well.

Capture Request Link if redirects are enabled

In the case of redirects being enabled the combination of the URIhttps://hover.to/api/v2/capture_requests/ + your Capture Requests unique identifier will redirect to your Capture Request link. This request itself will redirect and return an HTML page like the one shown in Figure A. This can be shared as your Capture Request link.

Capture Request Links if your organization does note create Capture Request via the API

If you are not creating the Capture Request via the API you can hit the endpoint to list all Capture Requests: ...api/v2/capture_requests/?current_user_id=<user_id>. These results are sorted oldest to newest, and you can query for specific values to locate the Capture Request, and thus Capture Request Identifier needed.