Pular para o conteúdo principal

Listar Validações

Este endpoint permite listar as validações criadas com a possibilidade de filtrar pelo businessId da validação e paginar os resultados.

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 JWT scope: catalisa/admin, doc-validation/admin, doc-validation/write:validations

Parâmetros​

NomeTipoDescrição
filter[businessId]stringOpcional. Identificador do documento no sistema do parceiro.
page[number]numberOpcional. Número da página a ser retornada. O padrão é 1.
page[size]numberOpcional. Quantidade de registros por página. O padrão é 10.

Cabeçalhos​

NomeValor
AuthorizationBearer <token>
Acceptapplication/json

Respostas​

CódigoDescrição
200Retorna a lista de documentos criados para assinatura eletrônica.
401Não autorizado

Paginação​

A paginação é feita através dos parâmetros page[number] e page[size]. O parâmetro page[number] indica o número da página a ser retornada, enquanto o parâmetro page[size] indica a quantidade de registros por página. Em cada resposta, a API retorna os links para a primeira (first), última (last), próxima (next) e anterior (prev).

Por padrão a API retorna os 10 primeiros documentos criados para assinatura eletrônica. Os registros são ordenados por data de criação, do mais antigo para o mais recente.

info

Caso não exista uma próxima página, o link next terá o valor null. Da mesma forma, caso não exista uma página anterior, o link prev terá o valor null.

Filtros​

A API permite filtrar os documentos pelo businessId da validação. Para isso, basta informar o parâmetro filter[businessId] na requisição.

Exemplo de uso sem filtros ou paginação​

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",
  requestOptions
);
const data = await response.json();
console.log(data);

Resposta​

{
    "data": [
        {
            "type": "validations",
            "id": "88267704-b94c-4102-a578-91cd2984fb95",
            "attributes": {
                "businessId": "972-57-716",
                "name": "Cliente_2023_152_681",
                "type": "document",
                "flowType": "web",
                "status": "pending"
            },
            "links": {
                "self": "https://api-dev.catalisa.com.br/doc-validation/api/v1/validations/88267704-b94c-4102-a578-91cd2984fb95"
            }
        },
    ],
    "links": {
        "self": "https://api-dev.catalisa.com.br/doc-validation/api/v1/validations?page%5Bnumber%5D=1&page%5Bsize%5D=10",
        "first": "https://api-dev.catalisa.com.br/doc-validation/api/v1/validations?page%5Bnumber%5D=1&page%5Bsize%5D=10",
        "last": "https://api-dev.catalisa.com.br/doc-validation/api/v1/validations?page%5Bnumber%5D=2&page%5Bsize%5D=10",
        "prev": null,
        "next": "https://api-dev.catalisa.com.br/doc-validation/api/v1/validations?page%5Bnumber%5D=2&page%5Bsize%5D=10"
    }
}

Exemplo de uso com filtro​

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?filter[businessId]=972-57-716",
  requestOptions
);
const data = await response.json();
console.log(data);

Resposta​

{
    "data": [
        {
            "type": "validations",
            "id": "88267704-b94c-4102-a578-91cd2984fb95",
            "attributes": {
                "businessId": "972-57-716",
                "name": "Cliente_2023_152_681",
                "type": "document",
                "flowType": "web",
                "status": "pending"
            },
            "links": {
                "self": "https://api-dev.catalisa.com.br/doc-validation/api/v1/validations/88267704-b94c-4102-a578-91cd2984fb95"
            }
        }
    ],
    "links": {
        "self": "https://api-dev.catalisa.com.br/doc-validation/api/v1/validations?filter%5BbusinessId%5D=972-57-716&page%5Bnumber%5D=1&page%5Bsize%5D=10",
        "first": "https://api-dev.catalisa.com.br/doc-validation/api/v1/validations?filter%5BbusinessId%5D=972-57-716&page%5Bnumber%5D=1&page%5Bsize%5D=10",
        "last": "https://api-dev.catalisa.com.br/doc-validation/api/v1/validations?filter%5BbusinessId%5D=972-57-716&page%5Bnumber%5D=2&page%5Bsize%5D=10",
        "prev": null,
        "next": null
    }
}

Exemplo de uso com paginação​

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?page[number]=2&page[size]=3",
  requestOptions
);
const data = await response.json();
console.log(data);

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"
            }
        },
        {
            "type": "validations",
            "id": "8c19ebaa-b262-4770-b793-acc9f018f2ab",
            "attributes": {
                "businessId": "573-439-344",
                "name": "Cliente_2023_947_163",
                "type": "document",
                "flowType": "web",
                "status": "pending"
            },
            "links": {
                "self": "https://api-dev.catalisa.com.br/doc-validation/api/v1/validations/8c19ebaa-b262-4770-b793-acc9f018f2ab"
            }
        },
        {
            "type": "validations",
            "id": "4818b0dd-8c71-434f-96dc-b6206ad799f2",
            "attributes": {
                "businessId": "971-207-194",
                "name": "Cliente_2023_20_556",
                "type": "document",
                "flowType": "web",
                "status": "pending"
            },
            "links": {
                "self": "https://api-dev.catalisa.com.br/doc-validation/api/v1/validations/4818b0dd-8c71-434f-96dc-b6206ad799f2"
            }
        }
    ],
    "links": {
        "self": "https://api-dev.catalisa.com.br/doc-validation/api/v1/validations?page%5Bnumber%5D=2&page%5Bsize%5D=3",
        "first": "https://api-dev.catalisa.com.br/doc-validation/api/v1/validations?page%5Bnumber%5D=1&page%5Bsize%5D=3",
        "last": "https://api-dev.catalisa.com.br/doc-validation/api/v1/validations?page%5Bnumber%5D=3&page%5Bsize%5D=3",
        "prev": "https://api-dev.catalisa.com.br/doc-validation/api/v1/validations?page%5Bnumber%5D=2&page%5Bsize%5D=3",
        "next": "https://api-dev.catalisa.com.br/doc-validation/api/v1/validations?page%5Bnumber%5D=3&page%5Bsize%5D=3"
    }
}