Listar origens cadastradas no VIDaaS

GET

signer

vidaas

redirect-uris

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

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://api.valid.com/signer/v1/vidaas/redirect-uris', 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/vidaas/redirect-uris",
  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/vidaas/redirect-uris"

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

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

[
  {
    "uuid": "550e8400-e29b-41d4-a716-446655440000",
    "origin": "https://assinador.cliente.com.br",
    "redirectUri": "https://assinador.cliente.com.br/sign/vidaas/callback",
    "projectId": "6ba7b810-9dad-11d1-80b4-00c04fd430c8",
    "status": "REGISTERED",
    "registeredAt": "2025-07-27T10:30:00Z",
    "lastError": null
  },
  {
    "uuid": "550e8400-e29b-41d4-a716-446655440001",
    "origin": "https://localhost:3000",
    "redirectUri": "https://localhost:3000/sign/vidaas/callback",
    "projectId": "6ba7b810-9dad-11d1-80b4-00c04fd430c8",
    "status": "REGISTERED",
    "registeredAt": "2025-07-27T10:35:00Z",
    "lastError": null
  }
]

HTTP/1.1 401 Unauthorized
Content-Type: application/json

{
  "statusCode": 401,
  "message": "Invalid API Key"
}

Lista todas as origens cadastradas como endereços de retorno válidos no VIDaaS para seu projeto. Use este endpoint para verificar o estado do cadastro antes de suspeitar que o VIDaaS perdeu a lista. Autenticação: use uma chave de API (x-api-key).

Parâmetros

Nenhum.

Respostas

Array de objetos, cada um representando um cadastro:

string

required

Identificador do cadastro.

string

required

Origem normalizada (como foi registrada).

string

required

URI completa de retorno (origem + caminho fixo). Exemplo: https://assinador.cliente.com.br/sign/vidaas/callback.

string

Tenant da Platform (extraído da chave de API).

string

required

Status do cadastro no provedor:

PENDING: enviado ao provedor mas ainda aguardando confirmação.
REGISTERED: aceito e registrado no provedor.
FAILED: o provedor recusou o cadastro (veja lastError).

string

Timestamp (ISO-8601) de quando o cadastro foi aceito pelo provedor. Presente apenas quando status = REGISTERED.

string

Descrição da última falha no cadastro. Presente apenas quando status = FAILED.

Erros

Veja Autenticação e erros.

401: Chave de API inválida ou expirada.
403: Origem não autorizada (raro — seu projeto está bloqueado).

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

[
  {
    "uuid": "550e8400-e29b-41d4-a716-446655440000",
    "origin": "https://assinador.cliente.com.br",
    "redirectUri": "https://assinador.cliente.com.br/sign/vidaas/callback",
    "projectId": "6ba7b810-9dad-11d1-80b4-00c04fd430c8",
    "status": "REGISTERED",
    "registeredAt": "2025-07-27T10:30:00Z",
    "lastError": null
  },
  {
    "uuid": "550e8400-e29b-41d4-a716-446655440001",
    "origin": "https://localhost:3000",
    "redirectUri": "https://localhost:3000/sign/vidaas/callback",
    "projectId": "6ba7b810-9dad-11d1-80b4-00c04fd430c8",
    "status": "REGISTERED",
    "registeredAt": "2025-07-27T10:35:00Z",
    "lastError": null
  }
]

HTTP/1.1 401 Unauthorized
Content-Type: application/json

{
  "statusCode": 401,
  "message": "Invalid API Key"
}

Exemplo

curl -X GET "https://api.valid.com/signer/v1/vidaas/redirect-uris" \
  -H "x-api-key: SEU_API_KEY"

Importante

Autenticação por API Key: este é um endpoint administrativo — use sua chave de API.
View-only: esta operação só consulta — não cria ou altera nada.
Filtrado por projeto: lista só as origens do seu projeto (extraído da chave de API).

Próximas etapas

Se alguma origem está com status: FAILED, veja o lastError e considere reenviar o cadastro com POST /signer/v1/vidaas/redirect-uris e force: true.
Se está faltando uma origem que você esperava, registre-a com POST /signer/v1/vidaas/redirect-uris.

⌘I

Listar origens cadastradas no VIDaaS

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

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://api.valid.com/signer/v1/vidaas/redirect-uris', 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/vidaas/redirect-uris",
  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/vidaas/redirect-uris"

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

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

[
  {
    "uuid": "550e8400-e29b-41d4-a716-446655440000",
    "origin": "https://assinador.cliente.com.br",
    "redirectUri": "https://assinador.cliente.com.br/sign/vidaas/callback",
    "projectId": "6ba7b810-9dad-11d1-80b4-00c04fd430c8",
    "status": "REGISTERED",
    "registeredAt": "2025-07-27T10:30:00Z",
    "lastError": null
  },
  {
    "uuid": "550e8400-e29b-41d4-a716-446655440001",
    "origin": "https://localhost:3000",
    "redirectUri": "https://localhost:3000/sign/vidaas/callback",
    "projectId": "6ba7b810-9dad-11d1-80b4-00c04fd430c8",
    "status": "REGISTERED",
    "registeredAt": "2025-07-27T10:35:00Z",
    "lastError": null
  }
]

HTTP/1.1 401 Unauthorized
Content-Type: application/json

{
  "statusCode": 401,
  "message": "Invalid API Key"
}

Primeiros Passos

Onboarding

Bureau

Liveness

Assinatura Digital

ID Check

Card Check

TrustPass

BPO

Extração Dados

Mensageria

Documentoscopia

Listar origens cadastradas no 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