Listar motivos de recusa

GET

signer

sign

:sessionToken

refusal-reasons

Listar motivos de recusa

curl --request GET \
  --url https://api.valid.com/signer/v1/sign/:sessionToken/refusal-reasons \
  --header 'x-api-key: <api-key>'

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

fetch('https://api.valid.com/signer/v1/sign/:sessionToken/refusal-reasons', 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/sign/:sessionToken/refusal-reasons",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  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/sign/:sessionToken/refusal-reasons"

	req, _ := http.NewRequest("GET", 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/sign/:sessionToken/refusal-reasons")

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

request = Net::HTTP::Get.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

[
  {
    "id": 1,
    "description": "Documento incorreto"
  },
  {
    "id": 2,
    "description": "Dados incompletos"
  },
  {
    "id": 3,
    "description": "Preciso de mais tempo"
  },
  {
    "id": 4,
    "description": "Já não concordo com os termos"
  },
  {
    "id": 5,
    "description": "Motivo não listado"
  }
]

HTTP/1.1 410 Gone
Content-Type: application/json

{
  "statusCode": 410,
  "message": "Session expired"
}

Lista os motivos pré-definidos de recusa de assinatura disponíveis para o signatário. Use esta chamada para exibir um menu de opções ao signatário antes de chamar o endpoint de recusa. Autenticação: use apenas o sessionToken na URL — nenhum header de autenticação é necessário.

Parâmetros

string

required

Token único da sessão do signatário.

Respostas

Array de objetos RefusalReason:

integer

Identificador numérico do motivo. Use este valor em POST .../refuse.

string

Descrição legível do motivo, ex.: "Documento incorreto", "Dados incompletos".

Erros

Veja Autenticação e erros.

404: Sessão não encontrada.
410: Session token expirado.

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

[
  {
    "id": 1,
    "description": "Documento incorreto"
  },
  {
    "id": 2,
    "description": "Dados incompletos"
  },
  {
    "id": 3,
    "description": "Preciso de mais tempo"
  },
  {
    "id": 4,
    "description": "Já não concordo com os termos"
  },
  {
    "id": 5,
    "description": "Motivo não listado"
  }
]

HTTP/1.1 410 Gone
Content-Type: application/json

{
  "statusCode": 410,
  "message": "Session expired"
}

Exemplo

curl -X GET "https://api.valid.com/signer/v1/sign/eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.../refusal-reasons" \
  -H "Content-Type: application/json"

Importante

Texto livre sempre oferecido: além das opções desta lista, a interface do signatário sempre oferece a possibilidade de digitar um motivo em texto livre (ex.: “Outros motivos”). Esse texto livre não vem desta lista — é capturado diretamente no formulário de recusa.
IDs numérricos: cada motivo tem um id — use-o ao chamar POST .../refuse.

Próximas etapas

Exiba os motivos desta lista como opções (ex.: botões, radio buttons, dropdown).
Se o signatário selecionar “Motivo não listado” ou digitar texto livre, capture-o.
Chame POST .../refuse com o motivo (id ou texto).

Relacionado

POST /signer/v1/sign/:sessionToken/refuse — recusar assinatura com motivo
GET /signer/v1/sign/:sessionToken — obter dados da sessão

⌘I

Listar motivos de recusa

curl --request GET \
  --url https://api.valid.com/signer/v1/sign/:sessionToken/refusal-reasons \
  --header 'x-api-key: <api-key>'

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

fetch('https://api.valid.com/signer/v1/sign/:sessionToken/refusal-reasons', 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/sign/:sessionToken/refusal-reasons",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  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/sign/:sessionToken/refusal-reasons"

	req, _ := http.NewRequest("GET", 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/sign/:sessionToken/refusal-reasons")

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

request = Net::HTTP::Get.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

[
  {
    "id": 1,
    "description": "Documento incorreto"
  },
  {
    "id": 2,
    "description": "Dados incompletos"
  },
  {
    "id": 3,
    "description": "Preciso de mais tempo"
  },
  {
    "id": 4,
    "description": "Já não concordo com os termos"
  },
  {
    "id": 5,
    "description": "Motivo não listado"
  }
]

HTTP/1.1 410 Gone
Content-Type: application/json

{
  "statusCode": 410,
  "message": "Session expired"
}

Primeiros Passos

Onboarding

Bureau

Liveness

Assinatura Digital

ID Check

Card Check

TrustPass

BPO

Extração Dados

Mensageria

Documentoscopia

Storage

Coleção Postman

Listar motivos de recusa

Parâmetros

Respostas

Erros

Exemplo

Importante

Próximas etapas

Relacionado

​Parâmetros

​Respostas

​Erros

​Exemplo

​Importante

​Próximas etapas

​Relacionado

Parâmetros

Respostas

Erros

Exemplo

Importante

Próximas etapas

Relacionado