Listar provedores de certificado em nuvem

GET

signer

sign

:sessionToken

integraicp

clearances

Listar provedores de certificado em nuvem

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

import requests

url = "https://api.valid.com/signer/v1/sign/:sessionToken/integraicp/clearances"

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/integraicp/clearances', 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/integraicp/clearances",
  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/integraicp/clearances"

	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/integraicp/clearances")

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,
  "clearances": [
    {
      "clearanceId": "01HXYZCLEARANCE001",
      "providerName": "Valid",
      "productName": "VIDaaS"
    },
    {
      "clearanceId": "01HXYZCLEARANCE002",
      "providerName": "Soluti",
      "productName": "BirdID"
    }
  ],
  "expiresAt": "2025-07-27T18:00:00Z",
  "providerStatus": "PENDING_AUTHORIZATION"
}

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

{
  "available": false,
  "clearances": [],
  "expiresAt": null,
  "providerStatus": "UNAVAILABLE_CLEARANCES"
}

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

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

Lista os provedores de serviço de confiança (PSCs) — como VIDaaS, BirdID, SafeID e SerproID — que possuem certificado em nuvem emitido para o CPF do signatário. Use esta chamada para oferecer ao signatário as opções de certificado disponíveis. 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 CPF do signatário tem certificado em nuvem em pelo menos um provedor.

array

Lista de provedores disponíveis. Vazio se nenhum certificado foi encontrado (available: false).

Show Propriedades de clearances[]

string

Identificador opaco da opção. Devolva este valor em POST .../integraicp/start.

string

Nome do provedor, ex.: "Valid", "Soluti", "SafeWeb", "Serpro", "CertiSign".

string

Nome do produto do provedor, ex.: "VIDaaS", "BirdID", "SafeID", "SerproID", "RemoteID".

string

Timestamp (ISO 8601) até quando as opções valem. Após expiração, liste de novo.

string

Estado devolvido pelo hub IntegraICP, ex.: PENDING_AUTHORIZATION, UNAVAILABLE_CLEARANCES.

Erros

Veja Autenticação e erros.

410: Session token expirado (envelope expirou ou foi deletado).
502: O hub IntegraICP não respondeu ou respondeu com erro.
503: Integração IntegraICP não configurada no ambiente.

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

{
  "available": true,
  "clearances": [
    {
      "clearanceId": "01HXYZCLEARANCE001",
      "providerName": "Valid",
      "productName": "VIDaaS"
    },
    {
      "clearanceId": "01HXYZCLEARANCE002",
      "providerName": "Soluti",
      "productName": "BirdID"
    }
  ],
  "expiresAt": "2025-07-27T18:00:00Z",
  "providerStatus": "PENDING_AUTHORIZATION"
}

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

{
  "available": false,
  "clearances": [],
  "expiresAt": null,
  "providerStatus": "UNAVAILABLE_CLEARANCES"
}

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

Importante

Lista vazia não é erro: se available: false, significa que o CPF do signatário não tem certificado em nuvem em nenhum provedor — é um resultado válido.
Prazo de validade: as opções devolvidas valem até expiresAt. Após essa data, liste de novo antes de oferecer as mesmas opções.
Sem header de autenticação: o sessionToken é toda a autenticação necessária.

Próximas etapas

Se available: true e há opções, mostre ao signatário e deixe escolher.
Ao escolher, chame POST .../integraicp/start com o clearanceId da opção selecionada.
Redirecione o navegador do signatário para o redirectUrl devolvido.

Relacionado

POST .../integraicp/start — registrar a escolha e obter URL de autenticação
GET .../integraicp/authorization — verificar o estado da autorização
POST /signer/v1/sign/:sessionToken/sign — assinar após autorizado

⌘I

Listar provedores de certificado em nuvem

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

import requests

url = "https://api.valid.com/signer/v1/sign/:sessionToken/integraicp/clearances"

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/integraicp/clearances', 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/integraicp/clearances",
  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/integraicp/clearances"

	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/integraicp/clearances")

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,
  "clearances": [
    {
      "clearanceId": "01HXYZCLEARANCE001",
      "providerName": "Valid",
      "productName": "VIDaaS"
    },
    {
      "clearanceId": "01HXYZCLEARANCE002",
      "providerName": "Soluti",
      "productName": "BirdID"
    }
  ],
  "expiresAt": "2025-07-27T18:00:00Z",
  "providerStatus": "PENDING_AUTHORIZATION"
}

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

{
  "available": false,
  "clearances": [],
  "expiresAt": null,
  "providerStatus": "UNAVAILABLE_CLEARANCES"
}

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 provedores de certificado em nuvem

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