Iniciar autenticação no provedor de certificado

POST

signer

sign

:sessionToken

integraicp

start

Iniciar autenticação no provedor de certificado

curl --request POST \
  --url https://api.valid.com/signer/v1/sign/:sessionToken/integraicp/start \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "clearanceId": "<string>"
}
'

import requests

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

payload = { "clearanceId": "<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({clearanceId: '<string>'})
};

fetch('https://api.valid.com/signer/v1/sign/:sessionToken/integraicp/start', 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/start",
  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([
    'clearanceId' => '<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/integraicp/start"

	payload := strings.NewReader("{\n  \"clearanceId\": \"<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/integraicp/start")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"clearanceId\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"clearanceId\": \"<string>\"\n}"

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

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

{
  "redirectUrl": "https://services.integraicp.com.br/c/your-channel/icp/v3/authentications/01HXYZCLEARANCE001?state=xyz&code_challenge=...",
  "providerName": "Valid",
  "productName": "VIDaaS"
}

HTTP/1.1 400 Bad Request
Content-Type: application/json

{
  "statusCode": 400,
  "message": "Clearance not found in available options"
}

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

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

Registra o provedor (PSC) escolhido pelo signatário e retorna a URL de autenticação no provedor. O signatário acessa essa URL no navegador, se autentica e autoriza o uso do certificado. 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.

string

required

Identificador da opção devolvida por GET .../integraicp/clearances. Deve estar entre as opções oferecidas.

Respostas

string

URL para onde levar o navegador do signatário. Ele se autentica e autoriza no provedor, que então redireciona de volta para o callback de sua aplicação.

string

Nome do provedor escolhido, ex.: "Valid", "Soluti".

string

Produto do provedor, ex.: "VIDaaS", "BirdID".

Erros

Veja Autenticação e erros.

400: clearanceId não é válido ou não está entre as opções oferecidas.
410: Session token expirado, ou as opções de autenticação venceram — liste de novo com GET .../integraicp/clearances.

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

{
  "redirectUrl": "https://services.integraicp.com.br/c/your-channel/icp/v3/authentications/01HXYZCLEARANCE001?state=xyz&code_challenge=...",
  "providerName": "Valid",
  "productName": "VIDaaS"
}

HTTP/1.1 400 Bad Request
Content-Type: application/json

{
  "statusCode": 400,
  "message": "Clearance not found in available options"
}

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

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

Exemplo

curl -X POST "https://api.valid.com/signer/v1/sign/eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.../integraicp/start" \
  -H "Content-Type: application/json" \
  -d '{
    "clearanceId": "01HXYZCLEARANCE001"
  }'

Fluxo completo

Esta chamada registra qual provedor o signatário escolheu.
Abra redirectUrl no navegador (ou redirecione o signatário para lá).
O signatário se autentica no provedor e autoriza o uso do certificado.
O provedor redireciona o navegador de volta para ${SIGNER_APP_BASE_URL}/sign/{sessionToken}?integraicp=authorized (ou ?integraicp=failed&message=... em caso de erro).
Consulte GET .../integraicp/authorization para confirmar que a autorização foi concluída.
Assine com POST /signer/v1/sign/:sessionToken/sign.

Relacionado

GET .../integraicp/clearances — listar opções de provedor
GET /signer/v1/integraicp/callback/:state — retorno do provedor (chamado automaticamente pelo navegador)
GET .../integraicp/authorization — verificar estado da autorização

⌘I

Iniciar autenticação no provedor de certificado

curl --request POST \
  --url https://api.valid.com/signer/v1/sign/:sessionToken/integraicp/start \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "clearanceId": "<string>"
}
'

import requests

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

payload = { "clearanceId": "<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({clearanceId: '<string>'})
};

fetch('https://api.valid.com/signer/v1/sign/:sessionToken/integraicp/start', 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/start",
  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([
    'clearanceId' => '<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/integraicp/start"

	payload := strings.NewReader("{\n  \"clearanceId\": \"<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/integraicp/start")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"clearanceId\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"clearanceId\": \"<string>\"\n}"

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

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

{
  "redirectUrl": "https://services.integraicp.com.br/c/your-channel/icp/v3/authentications/01HXYZCLEARANCE001?state=xyz&code_challenge=...",
  "providerName": "Valid",
  "productName": "VIDaaS"
}

HTTP/1.1 400 Bad Request
Content-Type: application/json

{
  "statusCode": 400,
  "message": "Clearance not found in available options"
}

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

Iniciar autenticação no provedor de certificado

Parâmetros

Respostas

Erros

Exemplo

Fluxo completo

Relacionado

​Parâmetros

​Respostas

​Erros

​Exemplo

​Fluxo completo

​Relacionado

Parâmetros

Respostas

Erros

Exemplo

Fluxo completo

Relacionado