Cancelar sessão de validação de envelope

POST

signer

validator

session

:sessionUuid

cancel

Cancelar sessão de validação de envelope

curl --request POST \
  --url https://api.valid.com/signer/v1/validator/session/:sessionUuid/cancel \
  --header 'x-api-key: <api-key>'

import requests

url = "https://api.valid.com/signer/v1/validator/session/:sessionUuid/cancel"

headers = {"x-api-key": "<api-key>"}

response = requests.post(url, headers=headers)

print(response.text)

const options = {method: 'POST', headers: {'x-api-key': '<api-key>'}};

fetch('https://api.valid.com/signer/v1/validator/session/:sessionUuid/cancel', 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.valid.com/signer/v1/validator/session/:sessionUuid/cancel",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <api-key>"
  ],
]);

$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.valid.com/signer/v1/validator/session/:sessionUuid/cancel"

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

	req.Header.Add("x-api-key", "<api-key>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.valid.com/signer/v1/validator/session/:sessionUuid/cancel")

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

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'

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

HTTP/1.1 200 OK
Content-Type: application/json

{
  "sessionUuid": "550e8400-e29b-41d4-a716-446655440000"
}

HTTP/1.1 404 Not Found
Content-Type: application/json

{
  "statusCode": 404,
  "message": "Validation session not found"
}

Cancela uma sessão de validação, invalidando-a imediatamente. Após cancelamento, tentativas de usar o sessionUuid retornarão 404. Use este endpoint para desativar uma sessão antes de seu TTL natural expirar (15 minutos). Autenticação: este endpoint é público — nenhuma autenticação é necessária.

Parâmetros

string

required

UUID da sessão de validação retornado por POST /signer/v1/validator/verify.

Respostas

string

required

UUID da sessão de validação cancelada (eco do parâmetro de entrada).

Erros

404: Sessão de validação não encontrada (já expirada ou cancelada).

HTTP/1.1 200 OK
Content-Type: application/json

{
  "sessionUuid": "550e8400-e29b-41d4-a716-446655440000"
}

HTTP/1.1 404 Not Found
Content-Type: application/json

{
  "statusCode": 404,
  "message": "Validation session not found"
}

Exemplo

curl -X POST "https://api.valid.com/signer/v1/validator/session/550e8400-e29b-41d4-a716-446655440000/cancel" \
  -H "Content-Type: application/json"

Importante

Sem autenticação: este endpoint é totalmente público.
Não reverte: o cancelamento é permanente — crie uma nova sessão se precisar consultar novamente.
Segurança: cancele uma sessão assim que terminar de usá-la, se o sessionUuid tiver sido compartilhado com usuários não confiáveis.

Próximas etapas

Se precisar validar novamente, crie uma nova sessão com POST /signer/v1/validator/verify.

⌘I

Cancelar sessão de validação de envelope

curl --request POST \
  --url https://api.valid.com/signer/v1/validator/session/:sessionUuid/cancel \
  --header 'x-api-key: <api-key>'

import requests

url = "https://api.valid.com/signer/v1/validator/session/:sessionUuid/cancel"

headers = {"x-api-key": "<api-key>"}

response = requests.post(url, headers=headers)

print(response.text)

const options = {method: 'POST', headers: {'x-api-key': '<api-key>'}};

fetch('https://api.valid.com/signer/v1/validator/session/:sessionUuid/cancel', 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.valid.com/signer/v1/validator/session/:sessionUuid/cancel",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <api-key>"
  ],
]);

$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.valid.com/signer/v1/validator/session/:sessionUuid/cancel"

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

	req.Header.Add("x-api-key", "<api-key>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.valid.com/signer/v1/validator/session/:sessionUuid/cancel")

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

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'

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

HTTP/1.1 200 OK
Content-Type: application/json

{
  "sessionUuid": "550e8400-e29b-41d4-a716-446655440000"
}

HTTP/1.1 404 Not Found
Content-Type: application/json

{
  "statusCode": 404,
  "message": "Validation session not found"
}

Primeiros Passos

Onboarding

Bureau

Liveness

Assinatura Digital

ID Check

Card Check

TrustPass

BPO

Extração Dados

Mensageria

Documentoscopia

Cancelar sessão de validação de envelope

Parâmetros

Respostas

Erros

Exemplo

Importante

Próximas etapas

​Parâmetros

​Respostas

​Erros

​Exemplo

​Importante

​Próximas etapas

Parâmetros

Respostas

Erros

Exemplo

Importante

Próximas etapas