Criar Validação

Quando uma validação é criada com sucesso, a API retorna o código de status HTTP 201 Created, com os dados da validação criado no corpo da resposta. No corpo da resposta é enviado um link, para acesso da validação do documento por reconhecimento facial.

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.

Descrição dos campos

Campo	Tipo	Descrição
businnesId	string	ID do negócio cadastrado préviamente
name	string	Nome da validação.
type	string	Tipo de validação
flowType	string	Definição do tipo de fluxo para validação.

info

Um dos campos fileUrl ou fileBase64 deve ser informado.

Requisição

POST https://api-sandbox.catalisa.com.br/doc-validation/api/v1/validations JWT scope: catalisa/admin, doc-validation/admin, doc-validation/write:validations

Parâmetros

Sem parâmetros

Cabeçalhos

Nome	Valor
Authorization	Bearer <token>
Content-Type	application/json

Exemplo de Requisição

Corpo da Requisição

{
  "businessId": "219-58-45",
  "name": "Cliente_2023_302_966",
  "type": "document",
  "flowType": "web"
}

Respostas

Código	Descrição
201	Documento criado com sucesso. Retorna os dados do documento criado
401	Não autorizado

Exemplo de uso

Javascript

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

const body = JSON.stringify({
  businessId: "219-58-45",
  name: "Cliente_2023_302_966",
  type: "document",
  flowType: "web"
});

const requestOptions = {
  method: "POST",
  headers: headers,
  body: body,
};

const response = await fetch(
  "https://api-sandbox.catalisa.com.br/doc-validation/api/v1/validations",
  requestOptions
);
const data = await response.json();
console.log(data);

CURL

curl --location --request POST 'https://api-sandbox.catalisa.com.br/doc-validation/api/v1/validations' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer <token>' \
--data-raw '{
  "businessId": "219-58-45",
  "name": "Cliente_2023_302_966",
  "type": "document",
  "flowType": "web"
}'

Exemplo de Sucesso

{
    "data": {
        "type": "validations",
        "id": "bc14b895-7ab8-4262-b28d-520c476cbda2",
        "attributes": {
            "businessId": "219-58-45",
            "name": "Cliente_2023_302_966",
            "type": "document",
            "flowType": "web",
            "status": "pending",
            "webValidationUrl": "https://identity.truora.com/preview/IPF5a46300b333dec616022425994f62fd9?account_id=bc14b895-7ab8-4262-b28d-520c476cbda2"
        },
        "links": {
            "self": "https://api-dev.catalisa.com.br/doc-validation/api/v1/validations/bc14b895-7ab8-4262-b28d-520c476cbda2"
        }
    }
}