Cancel Request

This action will cancel a credential request. Once a request is canceled, it cannot be undone and will prevent the request from being completed by any subjects. Any draft credentials are marked canceled and any already-active credentials in the request are revoked.

DELETE /request/{requestId}

Cancel Request

cURL

curl --request DELETE \
  --url https://api.example.com/request/{requestId}

import requests

url = "https://api.example.com/request/{requestId}"

response = requests.delete(url)

print(response.text)

const options = {method: 'DELETE'};

fetch('https://api.example.com/request/{requestId}', 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://api.example.com/request/{requestId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "DELETE",
]);

$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://api.example.com/request/{requestId}"

	req, _ := http.NewRequest("DELETE", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.delete("https://api.example.com/request/{requestId}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/request/{requestId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)

response = http.request(request)
puts response.read_body

201

{
  "success": true
}

{
  "statusCode": 400,
  "message": "Request already canceled",
  "error": "Bad Request"
}

{
  "statusCode": 404,
  "message": "Request not found",
  "error": "Not Found"
}

Headers

API-Version · string

Pin request, response, and webhook shapes to a specific dated API version (YYYY-MM-DD). Omit to use the version pinned to your API key (set when the key is created; new keys default to the latest version). New integrations should target the latest version.

Pattern: ^\d{4}-\d{2}-\d{2}$

Example:

"2026-07-06"

Path Parameters

requestId · string · required

Unique identifier of the credential request to cancel. Must be a valid MongoDB ObjectId.

Example:

"507f1f77bcf86cd799439011"

Response

201

application/json

Returns a confirmation of the cancellation.

success · boolean · required

Whether the operation was successful

Example:

true