Cancel a capture link
curl --request DELETE \
--url https://robust-parakeet-542.convex.site/v1/capture-links/{id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://robust-parakeet-542.convex.site/v1/capture-links/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.delete(url, headers=headers)
print(response.text)const options = {method: 'DELETE', headers: {Authorization: 'Bearer <token>'}};
fetch('https://robust-parakeet-542.convex.site/v1/capture-links/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://robust-parakeet-542.convex.site/v1/capture-links/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://robust-parakeet-542.convex.site/v1/capture-links/{id}"
req, _ := http.NewRequest("DELETE", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.delete("https://robust-parakeet-542.convex.site/v1/capture-links/{id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://robust-parakeet-542.convex.site/v1/capture-links/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Delete.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"id": "cap_8Fq2kT0aZx91LmPw",
"method": "link",
"contact": "<string>",
"language": "en",
"externalRef": "<string>",
"status": "pending",
"delivery": "not_sent",
"createdAt": 123,
"expiresAt": 123,
"deliveryFailure": "<string>",
"openedAt": 123,
"submittedAt": 123,
"verificationId": "<string>"
}{
"error": "Missing required fields: subjectName",
"details": {
"subjectName": "string of at most 200 characters"
}
}{
"error": "Invalid API key"
}{
"error": "This API key can't call POST /v1/verify/aml. Give it the \"verify:aml\" scope or use another key."
}{
"error": "Verification not found"
}{
"error": "Rate limit exceeded"
}Capture links
Cancel a capture link
A pending or opened link stops working and its prefilled details are removed. A submitted or expired link is returned unchanged.
DELETE
/
v1
/
capture-links
/
{id}
Cancel a capture link
curl --request DELETE \
--url https://robust-parakeet-542.convex.site/v1/capture-links/{id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://robust-parakeet-542.convex.site/v1/capture-links/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.delete(url, headers=headers)
print(response.text)const options = {method: 'DELETE', headers: {Authorization: 'Bearer <token>'}};
fetch('https://robust-parakeet-542.convex.site/v1/capture-links/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://robust-parakeet-542.convex.site/v1/capture-links/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://robust-parakeet-542.convex.site/v1/capture-links/{id}"
req, _ := http.NewRequest("DELETE", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.delete("https://robust-parakeet-542.convex.site/v1/capture-links/{id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://robust-parakeet-542.convex.site/v1/capture-links/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Delete.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"id": "cap_8Fq2kT0aZx91LmPw",
"method": "link",
"contact": "<string>",
"language": "en",
"externalRef": "<string>",
"status": "pending",
"delivery": "not_sent",
"createdAt": 123,
"expiresAt": 123,
"deliveryFailure": "<string>",
"openedAt": 123,
"submittedAt": 123,
"verificationId": "<string>"
}{
"error": "Missing required fields: subjectName",
"details": {
"subjectName": "string of at most 200 characters"
}
}{
"error": "Invalid API key"
}{
"error": "This API key can't call POST /v1/verify/aml. Give it the \"verify:aml\" scope or use another key."
}{
"error": "Verification not found"
}{
"error": "Rate limit exceeded"
}Authorizations
Your API key: gt_live_… or gt_test_…
Path Parameters
The capture link's id, cap_….
Pattern:
^cap_[A-Za-z0-9]{1,64}$Response
The link after cancelling.
Example:
"cap_8Fq2kT0aZx91LmPw"
Available options:
link, sms, whatsapp Available options:
en, sw Available options:
pending, opened, submitted, expired, cancelled Available options:
not_sent, pending, sent, failed Unix time in milliseconds.
Unix time in milliseconds.
The KYC check the submission became.

