Detalhar signatário

GET

api

signature-processes

{signature_process}

signers

{signer}

Detalhar signatário

curl --request GET \
  --url https://api.valid.com/api/signature-processes/{signature_process}/signers/{signer} \
  --header 'x-api-key: <api-key>'

import requests

url = "https://api.valid.com/api/signature-processes/{signature_process}/signers/{signer}"

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

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

print(response.text)

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

fetch('https://api.valid.com/api/signature-processes/{signature_process}/signers/{signer}', 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/api/signature-processes/{signature_process}/signers/{signer}",
  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/api/signature-processes/{signature_process}/signers/{signer}"

	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/api/signature-processes/{signature_process}/signers/{signer}")

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

{
  "uuid": "0f87a419-3b6c-41f9-bf03-987654321abc",
  "code": "SIGN001",
  "name": "Maria Oliveira",
  "email": "maria@example.com",
  "identifier": "12345678901",
  "qualification": "Diretora Financeira",
  "restrict_signer": true,
  "phone_country_code": "55",
  "phone_number": "11987654321",
  "birth_date": "1990-05-15",
  "token_type": 1,
  "files_uuids": [
    "b1f21a89-8f99-4db3-a7b3-abcdef123456"
  ]
}

Path Parameters

string

required

UUID do processo de assinatura. Exemplo: e7d4f2aa-34bc-4321-ae11-123456789abc

string

required

UUID do signatário. Exemplo: 0f87a419-3b6c-41f9-bf03-987654321abc

Response

string

UUID do signatário. Exemplo: 0f87a419-3b6c-41f9-bf03-987654321abc

string

Código do signatário. Exemplo: SIGN001

string

Nome do signatário. Exemplo: Maria Oliveira

string

E-mail do signatário. Exemplo: maria@example.com

string

Identificador (CPF). Exemplo: 12345678901

string

Qualificação. Exemplo: Diretora Financeira

boolean

Indica se há restrição para o signatário. Exemplo: true

string

DDI do telefone. Exemplo: 55

string

Número do telefone. Exemplo: 11987654321

string

Data de nascimento. Exemplo: 1990-05-15

integer

Tipo de token. Exemplo: 1

array

Lista de UUIDs dos arquivos associados.

{
  "uuid": "0f87a419-3b6c-41f9-bf03-987654321abc",
  "code": "SIGN001",
  "name": "Maria Oliveira",
  "email": "maria@example.com",
  "identifier": "12345678901",
  "qualification": "Diretora Financeira",
  "restrict_signer": true,
  "phone_country_code": "55",
  "phone_number": "11987654321",
  "birth_date": "1990-05-15",
  "token_type": 1,
  "files_uuids": [
    "b1f21a89-8f99-4db3-a7b3-abcdef123456"
  ]
}

Atualizar signatárioAtualiza os dados de um signatário em um processo de assinatura.

⌘I

Detalhar signatário

curl --request GET \
  --url https://api.valid.com/api/signature-processes/{signature_process}/signers/{signer} \
  --header 'x-api-key: <api-key>'

import requests

url = "https://api.valid.com/api/signature-processes/{signature_process}/signers/{signer}"

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

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

print(response.text)

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

fetch('https://api.valid.com/api/signature-processes/{signature_process}/signers/{signer}', 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/api/signature-processes/{signature_process}/signers/{signer}",
  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/api/signature-processes/{signature_process}/signers/{signer}"

	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/api/signature-processes/{signature_process}/signers/{signer}")

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

{
  "uuid": "0f87a419-3b6c-41f9-bf03-987654321abc",
  "code": "SIGN001",
  "name": "Maria Oliveira",
  "email": "maria@example.com",
  "identifier": "12345678901",
  "qualification": "Diretora Financeira",
  "restrict_signer": true,
  "phone_country_code": "55",
  "phone_number": "11987654321",
  "birth_date": "1990-05-15",
  "token_type": 1,
  "files_uuids": [
    "b1f21a89-8f99-4db3-a7b3-abcdef123456"
  ]
}

Primeiros Passos

Onboarding

Bureau

Liveness

Assinatura Digital

ID Check

BPO

Extração Dados

Mensageria

Documentoscopia

Path Parameters

Response

​Path Parameters

​Response

Path Parameters

Response