SmartCap

Este guia explica como funciona e como integrar a funcionalidade de envio de documentos

Como integrar

Request

POST
POST https://hml.certiface.com.br/facecaptcha/service/captcha/document

HeadersDescrição
Content-Typeapplication/json

Request example

{
"appkey": "eyJhbGciOiJIUzI",
"images": ["/9j/4AAQSkZ...","/9j/4AAQSkZ..."],
}

Body Params

BodyDescrição
appkeyAppkey gerada pelo método "/appkey".
imagesLista, imagens JPEG do documento em base64 na ordem Face A, Face B.

❗️

É bom saber

É obrigatório o envio do documento em um dos parâmetros (image ou qrcode).

Responses

Status CodeDescrição
200OK
400Requisição mal-formada, campos obrigatórios não foram enviados.
401Dados faltantes na requisição ou fora do padrão esperado.
500Falha interna do servidor.

Response HTTP 200

HeadersDescrição
Content-Typeapplication/json

Response example

{
    "appkey": "eyJhb..",
    "codigoDocumento: "12345"
}

Response Body

Quando o serviço captcha/document é executado, os seguintes campos são retornados:

BodyDescrição
appkeyChave de autenticação da aplicação utilizada na requisição.
codigoDocumentoCódigo único gerado para o documento processado.