| Elemento | Como funciona |
|---|
| POST /front | Analisa a frente e devolve o uuid que a vincula ao verso |
|---|
| POST /back | Analisa o verso e o cruza com a frente, usando esse uuid como relatedUuid |
|---|
| GET /listTemplates | Os documentos suportados. Com /{templateId}/details, quais campos esperar de cada um, e com /{templateId}/images, imagens de amostra anonimizadas |
|---|
| GET /version | Verifica a conectividade. Avalia-se o código de status, não o corpo |
|---|
| Autenticação | Cabeçalho Api-Key. Cada serviço tem sua própria chave, por ambiente |
|---|
| URL base | A VU entrega junto com a chave, conforme o ambiente |
|---|
| Entrada | info como referência de negócio e image em base64. No verso, também relatedUuid |
|---|
| Saída | uuid, id (o tipo de documento), front e back com os dados, crossMatchConfidence, code e message |
|---|
RequisiçãoPOST /back
// Cabeçalho: Api-Key: <sua chave do serviço>
{
"info": "onboarding-12345",
"image": "<foto do verso em base64, sem prefixo>",
"relatedUuid": "<o uuid que POST /front devolveu>"
}
{
"info": "onboarding-12345",
"image": "<foto do verso em base64, sem prefixo>",
"relatedUuid": "<o uuid que POST /front devolveu>"
}
"frontBackTemplateValidation": trueO verso corresponde à frente. Você revisa a consistência dos dados e decide."frontBackTemplateValidation": falseÉ o verso de outro documento. Você não aceita."message": "Cant get document fields"Na frente: não foi possível ler o documento. Você pede outra captura.
A regra de decisãoSeu backend
// Frente: aceitar exige as três condições.
const frenteOk =
status === 200 &&
body.message === "Operation end successfully." &&
body.id !== "unknown";
// Verso: além do anterior.
const versoOk = body.back.frontBackTemplateValidation === true;
// E você revisa body.crossMatchConfidence antes de dar os dados por bons.
const frenteOk =
status === 200 &&
body.message === "Operation end successfully." &&
body.id !== "unknown";
const versoOk = body.back.frontBackTemplateValidation === true;
Um 200 não significa dados extraídos
Uma foto sem documento legível também responde 200, com a mensagem "Cant get document fields" e o tipo de documento como "unknown". E um verso que não corresponde à frente responde 200 com "Operation end successfully.". Se você decidir só pelo código de status, aceita documentos ilegíveis e documentos montados com lados de dois documentos diferentes.