CLEARSALE

Solicitar Facematch

Através do endpoint a seguir, será criada uma requisição de Facematch entre as duas imagens fornecidas. Imagens de rostos 2D de documentos de identificação, de bancos de dados ou até de perfis de mídia social podem ser combinadas com outras imagens 2D, desde que sejam respeitados os requisitos.

Requisição

POST https://datatrustapi.clearsale.com.br/v1/transaction/{id}/facematch HTTP/1.1
Content-Type: application/json
Authorization: Bearer {Token}
{
	"minMatchLevel":"6",
	"image0":"{base64Image}",
	"image1":"{base64Image}"
}
POST https://datatrustapihml.clearsale.com.br/v1/transaction/{id}/facematch HTTP/1.1
Content-Type: application/json
Authorization: Bearer {Token}
{
	"minMatchLevel":"6",
	"image0":"{base64Image}",
	"image1":"{base64Image}"
}

Resposta

Requisição realizada com sucesso

HTTP/1.1 201 Created
Content-Type: application/json; charset=utf-8
{
	"createdDate": "2023-03-09T17:33:23.4692342+00:00",
	"status": "Processing",
	"transactionId": "c2a6b5c4-7650-4676-8322-b85c5e0357c1"
}

Requisição com parâmetros inválidos

HTTP/1.1 400 Bad Request
Content-Type: application/json; charset=utf-8
{
	"title": "One or more validation errors occurred.",
	"status": 422,
	"instance": "/",
	"errors": {
	   "base64": [
			"'base64' não pode ser nulo."
		],
		"Document": [
			"Document must be a valid CPF."
		]
}

Requisição com token expirado ou inválido

HTTP/1.1 401 Unauthorized  

Requisição com as permissões inválidas

HTTP/1.1 403 Forbidden  

Requisição sem resultados para exibição

HTTP/1.1 404 Not Found
Content-Type: application/json; charset=utf-8
{
	"title": "string",
	"status": 404,
	"detail": "string",
	"instance": "string",
}

Erro no processamento da requisição

HTTP/1.1 500 Internal Server Error
Content-Type: application/json; charset=utf-8
{
    "title": "string",
    "status": 500,
    "detail": "string",
    "instance": "string"
}

Dicionário de Variáveis

Request

NomeDescriçãoTipoTamanhoObrigatório
Image0Imagem em formato BASE64String-Sim
Image1Imagem em formato BASE64String-Sim
MinMatchLevelValor de match level desejado para ser considerado um match, deve ser entre 1 e 6Int-Não

Importante: Recomendamos que as fotos tenham o formato .JPG ou .PNG, e tenham no mínimo 150px de largura.

NomeDescriçãoTipoTamanho
IdentifierIDO valor enviado na transação será retornado na respostaString-
TransactionIdIdentificador da transação gerada pela Plataforma DataTrustString-
CPFO valor enviado na transação será retornado na respostaString11
ConfiabilityNível de confiabilidade entre as duas fotos enviadasInt1
IsMatchIndica se as fotos são da mesma pessoa ou nãoBool-
TransactionStatusStatus da transação. Possíveis status:
- Success
- Processing
- Error
String-
MessageCampo retornado caso aconteça qualquer tipo de erro no processamento da TransaçãoString-
ErrorsObjeto que apresenta mensagens de erro que indicam o motivo da não comparação de imagens na requisiçãoString[]-

Guia de match levels

Valores

NomeDescrição
Match level 0Indica que não houve match
Match Level 11/100 FAR
Match Level 21/250 FAR
Match Level 31/500 FAR
Match Level 41/1.000 FAR
Match Level 51/10.000 FAR
Match Level 61/100.000 FAR

FAR: Indica uma porcentagem de aceitação de casos em que ocorrem falsos resultados.

Importante: Os números de confiabilidade retornados variam de 0 a 6.