Definir modo de posicionamento da chancela

PUT

envelopes

:uuid

signers

:signerUuid

placement-mode

Definir modo de posicionamento da chancela

curl --request PUT \
  --url https://api.valid.com/v1/envelopes/:uuid/signers/:signerUuid/placement-mode \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "mode": {}
}'

import requests

url = "https://api.valid.com/v1/envelopes/:uuid/signers/:signerUuid/placement-mode"

payload = { "mode": {} }
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({mode: {}})
};

fetch('https://api.valid.com/v1/envelopes/:uuid/signers/:signerUuid/placement-mode', 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/v1/envelopes/:uuid/signers/:signerUuid/placement-mode",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'mode' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "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"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.valid.com/v1/envelopes/:uuid/signers/:signerUuid/placement-mode"

	payload := strings.NewReader("{\n  \"mode\": {}\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://api.valid.com/v1/envelopes/:uuid/signers/:signerUuid/placement-mode")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"mode\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.valid.com/v1/envelopes/:uuid/signers/:signerUuid/placement-mode")

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

request = Net::HTTP::Put.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"mode\": {}\n}"

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

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

{
  "signerUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "mode": "SIGNER",
  "clearedPlacements": false
}

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

{
  "signerUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "mode": "MANIFEST",
  "clearedPlacements": true
}

HTTP/1.1 401 Unauthorized
Content-Type: application/json

{
  "statusCode": 401,
  "message": "Missing or invalid authorization."
}

HTTP/1.1 409 Conflict
Content-Type: application/json

{
  "statusCode": 409,
  "message": "Signer already signed; the stamp can no longer be moved."
}

Define quem decide o local onde a chancela visual deste signatário será desenhada no PDF assinado. A escolha é feita por signatário e pode ser alterada enquanto o documento não foi assinado. Autenticação: x-api-key no header. Também aceita Authorization: Bearer com headers de projeto/organização.

Modos de posicionamento

Modo	Quem escolhe	Descrição
`MANIFEST`	Ninguém	A chancela vai para a grade da página de assinaturas (padrão)
`OPERATOR`	Operador	Quem monta o envelope marca o local exato no passo “Posicionar assinatura”
`SIGNER`	Signatário	O próprio signatário arrasta a chancela na tela de assinatura

Como funciona

O modo manda, não a coordenada: mesmo que haja coordenada gravada, ela só é usada se o modo autoriza.
Sair de OPERATOR ou SIGNER limpa a marcação: deixar o modo decide. A resposta informa se algo foi apagado via clearedPlacements.
Entrar em OPERATOR não limpa nada: é o operador recuperando seu posicionamento anterior.

Parâmetros

string

required

UUID do envelope.

string

required

UUID do signatário.

enum

required

Modo de posicionamento: MANIFEST, OPERATOR ou SIGNER.

Respostas

string

UUID do signatário.

string

O modo atualizado.

boolean

true se a troca de modo apagou marcações anteriores. Sair de OPERATOR ou SIGNER descarta a coordenada gravada, porque deixou de valer.

Erros

400: Modo desconhecido.
401: Autenticação ausente ou inválida.
404: Envelope ou signatário não encontrado neste projeto.
409: Signatário já assinou; a chancela não pode mais ser movida.

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

{
  "signerUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "mode": "SIGNER",
  "clearedPlacements": false
}

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

{
  "signerUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "mode": "MANIFEST",
  "clearedPlacements": true
}

HTTP/1.1 401 Unauthorized
Content-Type: application/json

{
  "statusCode": 401,
  "message": "Missing or invalid authorization."
}

HTTP/1.1 409 Conflict
Content-Type: application/json

{
  "statusCode": 409,
  "message": "Signer already signed; the stamp can no longer be moved."
}

Exemplo

curl -X PUT "https://api.valid.com/v1/envelopes/550e8400-e29b-41d4-a716-446655440000/signers/a1b2c3d4-e5f6-7890-abcd-ef1234567890/placement-mode" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "mode": "SIGNER"
  }'

Importante

Rejeita se assinado: uma vez que o signatário assinou, o modo não pode ser alterado.
Por signatário: cada signatário tem seu próprio modo, independentemente dos demais.
Coordenadas persistem: as marcações gravadas não são apagadas ao entrar em OPERATOR, apenas ao sair dele.

Próximas etapas

Use PUT .../:uuid/signers/:signerUuid/files/:fileUuid/position para marcar a posição exata quando o modo for OPERATOR.
Use POST .../:uuid/send para enviar o envelope aos signatários.

Relacionado

PUT .../:uuid/signers/:signerUuid/files/:fileUuid/position — definir posição exata (admin)
PUT /v1/sign/:sessionToken/files/:fileUuid/position — signatário posiciona na assinatura

⌘I

Definir modo de posicionamento da chancela

curl --request PUT \
  --url https://api.valid.com/v1/envelopes/:uuid/signers/:signerUuid/placement-mode \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "mode": {}
}'

import requests

url = "https://api.valid.com/v1/envelopes/:uuid/signers/:signerUuid/placement-mode"

payload = { "mode": {} }
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({mode: {}})
};

fetch('https://api.valid.com/v1/envelopes/:uuid/signers/:signerUuid/placement-mode', 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/v1/envelopes/:uuid/signers/:signerUuid/placement-mode",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'mode' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "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"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.valid.com/v1/envelopes/:uuid/signers/:signerUuid/placement-mode"

	payload := strings.NewReader("{\n  \"mode\": {}\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://api.valid.com/v1/envelopes/:uuid/signers/:signerUuid/placement-mode")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"mode\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.valid.com/v1/envelopes/:uuid/signers/:signerUuid/placement-mode")

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

request = Net::HTTP::Put.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"mode\": {}\n}"

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

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

{
  "signerUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "mode": "SIGNER",
  "clearedPlacements": false
}

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

{
  "signerUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "mode": "MANIFEST",
  "clearedPlacements": true
}

HTTP/1.1 401 Unauthorized
Content-Type: application/json

{
  "statusCode": 401,
  "message": "Missing or invalid authorization."
}

HTTP/1.1 409 Conflict
Content-Type: application/json

{
  "statusCode": 409,
  "message": "Signer already signed; the stamp can no longer be moved."
}

Primeiros Passos

Onboarding

Bureau

Liveness

Assinatura Digital

ID Check

Card Check

TrustPass

BPO

Extração Dados

Mensageria

Documentoscopia

Storage

Coleção Postman

Definir modo de posicionamento da chancela

Modos de posicionamento

Como funciona

Parâmetros

Respostas

Erros

Exemplo

Importante

Próximas etapas

Relacionado

​Modos de posicionamento

​Como funciona

​Parâmetros

​Respostas

​Erros

​Exemplo

​Importante

​Próximas etapas

​Relacionado

Modos de posicionamento

Como funciona

Parâmetros

Respostas

Erros

Exemplo

Importante

Próximas etapas

Relacionado