Abrir autorização VIDaaS

POST

signer

sign

:sessionToken

vidaas

authorization

Abrir autorização VIDaaS

curl --request POST \
  --url https://api.valid.com/signer/v1/sign/:sessionToken/vidaas/authorization \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "mode": {},
  "identifier": "<string>",
  "callbackUrl": "<string>"
}
'

import requests

url = "https://api.valid.com/signer/v1/sign/:sessionToken/vidaas/authorization"

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

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

print(response.text)

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

fetch('https://api.valid.com/signer/v1/sign/:sessionToken/vidaas/authorization', 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/vidaas/authorization",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'mode' => [
        
    ],
    'identifier' => '<string>',
    'callbackUrl' => '<string>'
  ]),
  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/signer/v1/sign/:sessionToken/vidaas/authorization"

	payload := strings.NewReader("{\n  \"mode\": {},\n  \"identifier\": \"<string>\",\n  \"callbackUrl\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", 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.post("https://api.valid.com/signer/v1/sign/:sessionToken/vidaas/authorization")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"mode\": {},\n  \"identifier\": \"<string>\",\n  \"callbackUrl\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.valid.com/signer/v1/sign/:sessionToken/vidaas/authorization")

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

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

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

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

{
  "mode": "qrcode",
  "qrCodeUrl": "https://vidaas.valid.com/auth?code=abc123&state=xyz789",
  "pushCode": null
}

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

{
  "mode": "push",
  "qrCodeUrl": null,
  "pushCode": "push_handle_abc123xyz789"
}

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

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

Inicia o fluxo de autorização do signatário no VIDaaS. Você pode escolher entre dois modos:

qrcode: devolve um endereço que o signatário lê com o aplicativo VIDaaS.
push: envia uma notificação para o aplicativo do signatário; você depois consulta o status com polling.

Nenhuma assinatura é feita aqui — apenas a autorização que a precede. Após autorização bem-sucedida, chame POST /signer/v1/sign/:sessionToken/sign para assinar usando o VIDaaS. 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 (obtido em POST /signer/v1/envelopes ou POST /signer/v1/templates/:uuid/envelopes).

enum

required

Modo de autorização: qrcode ou push.

qrcode: devolve qrCodeUrl — o signatário lê com o aplicativo VIDaaS.
push: devolve pushCode — você faz polling para saber quando foi aprovado.

string

CPF/CNPJ do titular do certificado (quando diferente do signatário). Só é considerado se o signatário não estiver restrito ao próprio documento; caso contrário é ignorado. Formato: números e separadores ., -, /.

string

URL de retorno do front (para o modo QR Code), quando a origem da requisição não for utilizável. Deve ser da mesma origem que a requisição e já estar cadastrada no cliente VIDaaS. Sem ela, usa-se a origem da requisição + caminho padrão de callback.

Respostas

string

required

Eco do modo solicitado: qrcode ou push.

string

Endereço do QR Code para o signatário ler com o aplicativo VIDaaS. Presente apenas se mode = qrcode.

string

Handle para acompanhar a aprovação da notificação push. Presente apenas se mode = push. Passe este valor em POST /signer/v1/sign/:sessionToken/vidaas/authorization/poll.

Erros

Veja Autenticação e erros.

400: mode inválido ou validação falhou.
410: Session token expirado (envelope expirou ou foi deletado).
502: O VIDaaS não respondeu ou respondeu com erro.
503: Integração VIDaaS não configurada no ambiente.

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

{
  "mode": "qrcode",
  "qrCodeUrl": "https://vidaas.valid.com/auth?code=abc123&state=xyz789",
  "pushCode": null
}

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

{
  "mode": "push",
  "qrCodeUrl": null,
  "pushCode": "push_handle_abc123xyz789"
}

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

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

Exemplos

QR Code:

curl -X POST "https://api.valid.com/signer/v1/sign/eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.../vidaas/authorization" \
  -H "Content-Type: application/json" \
  -d '{
    "mode": "qrcode"
  }'

Push notification:

curl -X POST "https://api.valid.com/signer/v1/sign/eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.../vidaas/authorization" \
  -H "Content-Type: application/json" \
  -d '{
    "mode": "push"
  }'

Importante

Sem autenticação por header: o sessionToken é toda a autenticação necessária.
QR Code vs push: escolha o modo baseado na experiência do usuário desejada. QR Code força redirecionamento; push permite que o signatário autorize no aplicativo dele.
Callback URL: quando está em desenvolvimento ou atrás de proxy, informe callbackUrl explicitamente para evitar redirecionamentos quebrados.
Autorização com prazo: a autorização obtida (se bem-sucedida) tem prazo de validade — use POST /signer/v1/sign/:sessionToken/sign logo após antes de expirar.

Próximas etapas

Se mode = qrcode:

Abra qrCodeUrl no navegador (ou exiba como QR Code na tela).
O signatário lê o código com o aplicativo VIDaaS.
O VIDaaS redireciona o navegador de volta para o callbackUrl (ou origem da requisição).
Chame GET /signer/v1/sign/:sessionToken/vidaas/authorization para confirmar que a autorização está pronta.
Assine com POST /signer/v1/sign/:sessionToken/sign.

Se mode = push:

Faça polling com POST /signer/v1/sign/:sessionToken/vidaas/authorization/poll, passando o pushCode.
Quando a resposta for status: authorized, a autorização está pronta.
Assine com POST /signer/v1/sign/:sessionToken/sign.

⌘I

Abrir autorização VIDaaS

curl --request POST \
  --url https://api.valid.com/signer/v1/sign/:sessionToken/vidaas/authorization \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "mode": {},
  "identifier": "<string>",
  "callbackUrl": "<string>"
}
'

import requests

url = "https://api.valid.com/signer/v1/sign/:sessionToken/vidaas/authorization"

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

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

print(response.text)

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

fetch('https://api.valid.com/signer/v1/sign/:sessionToken/vidaas/authorization', 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/vidaas/authorization",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'mode' => [
        
    ],
    'identifier' => '<string>',
    'callbackUrl' => '<string>'
  ]),
  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/signer/v1/sign/:sessionToken/vidaas/authorization"

	payload := strings.NewReader("{\n  \"mode\": {},\n  \"identifier\": \"<string>\",\n  \"callbackUrl\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", 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.post("https://api.valid.com/signer/v1/sign/:sessionToken/vidaas/authorization")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"mode\": {},\n  \"identifier\": \"<string>\",\n  \"callbackUrl\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.valid.com/signer/v1/sign/:sessionToken/vidaas/authorization")

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

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

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

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

{
  "mode": "qrcode",
  "qrCodeUrl": "https://vidaas.valid.com/auth?code=abc123&state=xyz789",
  "pushCode": null
}

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

{
  "mode": "push",
  "qrCodeUrl": null,
  "pushCode": "push_handle_abc123xyz789"
}

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

Abrir autorização VIDaaS

Parâmetros

Respostas

Erros

Exemplos

Importante

Próximas etapas

​Parâmetros

​Respostas

​Erros

​Exemplos

​Importante

​Próximas etapas

Parâmetros

Respostas

Erros

Exemplos

Importante

Próximas etapas