Nexmo

Redact API

The [Redact API](/redact/overview) helps organisations meet their privacy compliance obligations. It provides controlled, on-demand redaction of private…

Other#openapi

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

The Redact API helps organisations meet their privacy compliance obligations. It provides controlled, on-demand redaction of private information from transactional records in the long-term storage. Note, Redact API does not have the capability to redact the short-lived server logs that are retained for a few weeks. For SMS customers that need immediate redaction, Vonage suggests using Advanced Auto-redact.

Endpoints 1

  • POSTRedact a specific message/transaction

API details

Base URL
https://api.nexmo.com/v1/redact
Authentication
HTTP Basic authentication (username and password)
Operations
1 operation on 1 pathPOST 1
Response formats
application/json
Description format
OpenAPI 3.0.0, API version 1.0.6
Listed from
APIs.guru OpenAPI Directory (CC0-1.0)
Source updated

How to test the Redact API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Redact API collection, without the publisher's secrets.
  3. Add your credentialsThis API uses HTTP Basic authentication (username and password). Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Redact a specific message” (POST /transaction), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Redact API?

The [Redact API](/redact/overview) helps organisations meet their privacy compliance obligations. It provides controlled, on-demand redaction of private… It is listed under Other and has 1 endpoint.

Who publishes the Redact API?

It is listed from Nexmo's public API description (an OpenAPI document), not published by Nexmo on Swastik Codes. Anyone who controls nexmo.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Redact API?

Requests go to https://api.nexmo.com/v1/redact. Endpoint paths are added to this base URL.

How do I authenticate with the Redact API?

With HTTP Basic authentication (username and password).

How many endpoints does the Redact API have?

1 operation on 1 path (1 POST).

Is forking the Redact API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.