Documentação
CLEARSALE

Recuperação de captura aprovada

Suggest Edits

🚧

A partir de 08/10/2024, foi implementado um novo endpoint de recuperação de capturas aprovadas que utiliza os parâmetros obtidos na autenticação via Plataforma Data Trust. Recomenda-se que todos façam a alteração, pois, futuramente, será o único endpoint. Para mais informações, confira a seção Exemplos.

Introdução

É possível recuperar capturas aprovadas pelos SDKs Liveness ClearSale via endpoint, além do retorno imediato das classes de resultado do Liveness em cada SDK (conferir documentação técnica de cada um). Abaixo, trazemos exemplos de como realizar esse processo.

Exemplos

Método utilizando a Transaction (08/10/204)

Requisição de recuperação de captura

GET <https://datatrustapihml.clearsale.com.br/v1/transaction/{transactionId}/liveness> HTTP/1.1  
Content-Type: application/json  
Authentication: Bearer {Token} //Obtido via https://datatrustapihml.clearsale.com.br/v1/authentication

GET <https://datatrustapi.clearsale.com.br/v1/transaction/{transactionId}/liveness> HTTP/1.1  
Content-Type: application/json  
Authentication: Bearer {Token} //Obtido via https://datatrustapi.clearsale.com.br/v1/authentication

Resposta de sucesso

HTTP/1.1 200 OK  
Content-Type: application/json; charset=utf-8
{
  "sessionId": "", //Id da sessão gerada pelo SDK
	"image": "", //Imagem em formato Base64
	"createdAt": "" //Timestamp do armazenamento da imagem
}

📘

Caso para uma mesma transação (transactionId) exista mais de uma captura aprovada, será retornada apenas a última.

Método legado

Autenticação

POST <https://liveness-hml.clearsale.com.br/api/auth> HTTP/1.1
Content-Type: application/json
{
    "clientId": "*******", //identifica o cliente junto à ClearSale. É o mesmo valor fornecido pela ClearSale para a utilização dos SDKs
    "clientSecret": "*******" //chave de autenticação da ClearSale. É o mesmo valor fornecido pela ClearSale para a utilização dos SDKs
}

POST <https://liveness.clearsale.com.br/api/auth> HTTP/1.1
Content-Type: application/json
{
    "clientId": "*******", //identifica o cliente junto à ClearSale. É o mesmo valor fornecido pela ClearSale para a utilização dos SDKs
    "clientSecret": "*******" //chave de autenticação da ClearSale. É o mesmo valor fornecido pela ClearSale para a utilização dos SDKs
}

Resposta de sucesso

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
    "accessToken":"*******",
    "expiresIn": 300,
    "tokenType": "Bearer",
}

Em caso de sucesso, você receberá o accessToken necessário para a realização da chamada de recuperação da imagem:

Requisição de recuperação de captura

GET <https://liveness-hml.clearsale.com.br/api/image/{sessionId}> HTTP/1.1  
Content-Type: application/json  
Authentication: Bearer {accessToken}

GET <https://liveness.clearsale.com.br/api/image/{sessionId}> HTTP/1.1  
Content-Type: application/json  
Authentication: Bearer {accessToken}

Resposta de sucesso

HTTP/1.1 200 OK  
Content-Type: application/json; charset=utf-8  
Imagem em formato Base64

Updated about 1 month ago