Buscar Validação pelo ID

Este endpoint permite consultar os dados de uma validação criada.

Segurança

Para acessar a API, é necessário obter um token de acesso através do fluxo de autenticação OAuth2. Veja mais detalhes em Como obter acesso?

info

Ao gerar o token JWT, não esqueça de utilizar o escopo correto. Caso contrário, a requisição será rejeitada com o código de erro 401 Unauthorized.

Requisição

GET https://api-sandbox.catalisa.com.br/doc-validation/api/v1/validations/{id} JWT scope: catalisa/admin, doc-validation/admin, doc-validation/write:validations

Parâmetros

Nome	Tipo	Descrição
id	string	Identificador único da validação, no formato UUID.

Cabeçalhos

Nome	Valor
Authorization	Bearer <token>
Accept	application/json

Respostas

Código	Descrição
200	Retorna os dados do documento criado para assinatura eletrônica.
401	Não autorizado

Exemplo de uso

Javascript

const headers = new Headers();
headers.append("Authorization", "Bearer <token>");
headers.append("Accept", "application/json");

const requestOptions = {
  method: "GET",
  headers: headers,
};

const response = await fetch(
  "https://api-sandbox.catalisa.com.br/doc-validation/api/v1/validations/34c1a211-010e-4956-8f93-63e15203f8f7",
  requestOptions
);
const data = await response.json();
console.log(data);

CURL

curl --location --request GET 'https://api-sandbox.catalisa.com.br/doc-validation/api/v1/validations/34c1a211-010e-4956-8f93-63e15203f8f7' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <token>'

Exemplo de Resposta

{
    "data": {
        "type": "validations",
        "id": "34c1a211-010e-4956-8f93-63e15203f8f7",
        "attributes": {
            "businessId": "765-813-605",
            "name": "Cliente_2023_918_904",
            "type": "document",
            "flowType": "web",
            "status": "pending"
        },
        "links": {
            "self": "https://api-dev.catalisa.com.br/doc-validation/api/v1/validations/34c1a211-010e-4956-8f93-63e15203f8f7"
        }
    }
}