OCR de CPF
Este artigo explica como verificar se um CPF está em um documento através da REST API do Unico Check.
Esse método verifica se existe um determinado CPF em um documento que foi fornecido juntamente com o CPF na requisição.
Como usar?
Faça uma requisição POST para o endpoint /documents/ocrcode
Com o token de acesso válido, faça uma requisição para o endpoint (POST/documents/ocrcode) enviando os seguintes parâmetros:
{
"Code": "CPF_Titular",
"Base64Documento": "IMAGEM_DOCUMENTO"
}
Parametros:
- HEADER PARAMETERS
Nome | Tipo | Mandatorio/Opcional | Descrição |
---|---|---|---|
APIKEY | String | Mandatório | API key |
Authorization | String | Mandatório | Token de acesso |
Content-Type | String | Mandatório | "application/json" |
- REQUEST BODY SCHEMA
Nome | Tipo | Mandatorio/Opcional | Descrição |
---|---|---|---|
code | String | Mandatório | CPF válido |
Base64Documento | String | Mandatório | Foto do documento. A imagem precisa ser em base64 (png, jpg, jpeg) |
Exemplo de requisição:
{
"code": "12345678910",
"Base64Documento": "iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAAJcEhZcwAADsQAAA7EAZUrDhsAAAAgSURBVDhPY/wPBAwUACYoTTYYNWDUABAYNWDgDWBgAABrygQclUTopgAAAABJRU5ErkJggg=="
}
Requisição com Sucesso
Se a requisição foi executada com sucesso, a resposta de retorno é um JSON contendo o status da consulta como a seguir:
{
"Status": true
}
Erro na Requisição
Caso ocorra algum erro, a resposta de retorno é um JSON contendo o código e descrição do erro:
{
"Error": {
"code": "40004",
"description": "Descrição do erro"
}
}
Para mais infomações sobre os erros retornados, consulte a lista disponível no artigo Response Errors.
Dúvidas?
Não encontrou algo ou ainda precisa de ajuda? Se já é um cliente ou parceiro, pode entrar em contato através da Central de Ajuda.