Verificar disponibilidade de VIDaaS

GET

signer

sign

:sessionToken

vidaas

availability

Verificar disponibilidade de VIDaaS

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

import requests

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

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/signer/v1/sign/:sessionToken/vidaas/availability', 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/availability",
  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/vidaas/availability"

	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/vidaas/availability")

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

{
  "available": true,
  "certificateCount": 1
}

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

{
  "available": false,
  "certificateCount": null
}

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

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

Verifica se o signatário da sessão atual possui um certificado em nuvem VIDaaS registrado. Serve para a aplicação saber se deve oferecer a modalidade VIDaaS de assinatura ou se deve usar apenas as demais estratégias (PAdES avançado via MFA, ou eletrônica simples). 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).

Respostas

boolean

required

Se o signatário possui certificado em nuvem VIDaaS registrado e disponível para uso.

integer

Quantidade de certificados encontrados quando o provedor VIDaaS informa (pode ser null).

Erros

Veja Autenticação e erros.

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

{
  "available": true,
  "certificateCount": 1
}

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

{
  "available": false,
  "certificateCount": null
}

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.../vidaas/availability" \
  -H "Content-Type: application/json"

Importante

Sem autenticação por header: o sessionToken é toda a autenticação necessária.
Sem efeitos colaterais: esta chamada só consulta — não cria sessão de autorização, não marca a sessão como visitada.
Certificado do signatário: verifica se existe certificado no VIDaaS para o CPF/CNPJ do signatário da sessão atual.

Próximas etapas

Se available for true:

Chame POST /signer/v1/sign/:sessionToken/vidaas/authorization para abrir a autorização (QR Code ou push).
Complete a autorização (QR Code ou poll de push).
Assine normalmente com POST /signer/v1/sign/:sessionToken/sign — o endpoint usa a autorização VIDaaS automaticamente.

Se available for false:

Ofereça outras modalidades (MFA para PAdES avançado ou eletrônica simples).

⌘I

Verificar disponibilidade de VIDaaS

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

import requests

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

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/signer/v1/sign/:sessionToken/vidaas/availability', 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/availability",
  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/vidaas/availability"

	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/vidaas/availability")

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

{
  "available": true,
  "certificateCount": 1
}

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

{
  "available": false,
  "certificateCount": null
}

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

Verificar disponibilidade de VIDaaS

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