Verificar status da autorização

GET

signer

sign

:sessionToken

integraicp

authorization

Verificar status da autorização

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

import requests

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

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

	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/authorization")

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

{
  "status": "authorized",
  "providerName": "Valid",
  "productName": "VIDaaS",
  "certificateHolder": "João da Silva Santos",
  "certificateIdentifier": "12345678901",
  "expiresAt": "2025-07-27T14:30:00Z",
  "error": null
}

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

{
  "status": "pending",
  "providerName": "Soluti",
  "productName": "BirdID",
  "certificateHolder": null,
  "certificateIdentifier": null,
  "expiresAt": null,
  "error": null
}

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

{
  "status": "failed",
  "providerName": "Valid",
  "productName": "VIDaaS",
  "certificateHolder": null,
  "certificateIdentifier": null,
  "expiresAt": null,
  "error": "User denied authorization"
}

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

{
  "status": "none",
  "providerName": null,
  "productName": null,
  "certificateHolder": null,
  "certificateIdentifier": null,
  "expiresAt": null,
  "error": null
}

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

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

Verifica o estado atual da autenticação e autorização do signatário no provedor de certificado em nuvem. Use esta chamada para saber se a autenticação foi concluída com sucesso, falhou ou ainda está pendente. 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.

Respostas

enum

Estado atual da autorização. Um dos valores:

none — nenhuma sessão de autorização iniciada.
pending — autenticação em andamento; aguardando o signatário voltar do provedor.
authorized — autorização bem-sucedida; pronto para assinar.
expired — opções de autenticação ou credencial vencidas.
signed — a credencial já foi usada para assinar; não pode ser reutilizada.
failed — autenticação ou autorização falhou (motivo em error).

string

Nome do provedor escolhido, ex.: "Valid", "Soluti". Presente quando status não é none.

string

Produto do provedor, ex.: "VIDaaS", "BirdID". Presente quando status não é none.

string

Titular do certificado autenticado (nome completo). Preenchido quando status é authorized, signed ou failed.

string

CPF ou CNPJ do titular, só dígitos. Preenchido quando status é authorized, signed ou failed.

string

Timestamp (ISO 8601) de quando a credencial vence. Preenchido quando status é authorized.

string

Motivo da falha. Preenchido apenas quando status é failed.

Erros

Veja Autenticação e erros.

410: Session token expirado (envelope expirou ou foi deletado).

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

{
  "status": "authorized",
  "providerName": "Valid",
  "productName": "VIDaaS",
  "certificateHolder": "João da Silva Santos",
  "certificateIdentifier": "12345678901",
  "expiresAt": "2025-07-27T14:30:00Z",
  "error": null
}

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

{
  "status": "pending",
  "providerName": "Soluti",
  "productName": "BirdID",
  "certificateHolder": null,
  "certificateIdentifier": null,
  "expiresAt": null,
  "error": null
}

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

{
  "status": "failed",
  "providerName": "Valid",
  "productName": "VIDaaS",
  "certificateHolder": null,
  "certificateIdentifier": null,
  "expiresAt": null,
  "error": "User denied authorization"
}

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

{
  "status": "none",
  "providerName": null,
  "productName": null,
  "certificateHolder": null,
  "certificateIdentifier": null,
  "expiresAt": null,
  "error": 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.../integraicp/authorization" \
  -H "Content-Type: application/json"

Estados e próximas ações

Status	Ação
`none`	Nenhuma autenticação iniciada. Chame `POST .../integraicp/start` para começar.
`pending`	Aguarde o signatário completar a autenticação no provedor. Consulte novamente em alguns segundos.
`authorized`	Autorização bem-sucedida! O signatário pode agora assinar com `POST /signer/v1/sign/:sessionToken/sign`.
`expired`	Opções ou credencial venceram. Inicie novamente com `GET .../integraicp/clearances`.
`signed`	Credencial já foi usada. Inicie uma nova autorização se necessário.
`failed`	Autenticação ou autorização falhou. Oferça ao signatário a opção de tentar novamente com outro provedor.

Relacionado

GET .../integraicp/clearances — listar provedores disponíveis
POST .../integraicp/start — iniciar autenticação
POST /signer/v1/sign/:sessionToken/sign — assinar com certificado autorizado

⌘I

Verificar status da autorização

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

import requests

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

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

	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/authorization")

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

{
  "status": "authorized",
  "providerName": "Valid",
  "productName": "VIDaaS",
  "certificateHolder": "João da Silva Santos",
  "certificateIdentifier": "12345678901",
  "expiresAt": "2025-07-27T14:30:00Z",
  "error": null
}

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

{
  "status": "pending",
  "providerName": "Soluti",
  "productName": "BirdID",
  "certificateHolder": null,
  "certificateIdentifier": null,
  "expiresAt": null,
  "error": null
}

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

{
  "status": "failed",
  "providerName": "Valid",
  "productName": "VIDaaS",
  "certificateHolder": null,
  "certificateIdentifier": null,
  "expiresAt": null,
  "error": "User denied authorization"
}

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

{
  "status": "none",
  "providerName": null,
  "productName": null,
  "certificateHolder": null,
  "certificateIdentifier": null,
  "expiresAt": null,
  "error": 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

Storage

Coleção Postman

Verificar status da autorização

Parâmetros

Respostas

Erros

Exemplo

Estados e próximas ações

Relacionado

​Parâmetros

​Respostas

​Erros

​Exemplo

​Estados e próximas ações

​Relacionado

Parâmetros

Respostas

Erros

Exemplo

Estados e próximas ações

Relacionado