Pular para o conteúdo

OCR de Cartão de Identidade de Gana

reconhecimento de número de identificação + nome

Exemplo de código:

curl --location --request POST 'https://api.ekycpro.com/v1/gn_ocr/general' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'X-API-Key: AbcdEfgh' \
--data-urlencode 'img=BASE64_ENCODE_VALUE'

Resposta para reconhecimento bem-sucedido

{
"status": "OK",
"message": {
"dateOfBirth": "02/02/1990",
"dateOfExpiry": "14/05/2029",
"dateOfIssue": "16/05/2019",
"documentId": "AC2938503",
"firstname": "PRINCE DAVID OPPONG",
"gender": "M",
"nationality": "GHANAIAN",
"personalId": "GHA-712808643-8",
"placeOfIssue": "ACCRA",
"surname": "OBENG"
}
}

Resposta para falha no reconhecimento

{
"status": "FAIL",
"message": "check input image and retry"
}

Resposta para imagem de entrada não ser um cartão de identidade

{
"status": "FAIL",
"message": "not identity card"
}

Resposta para tipo de cartão não reconhecido

{
"status": "FAIL",
"message": "card not recognized"
}

Resposta para parâmetros de solicitação inválidos

{
"status": "INVALID_REQUEST",
"message": "check request params"
}

Resposta para formato de imagem inválido

{
"status": "IMAGE_INVALID_FORMAT",
"message": "image format not support"
}

Resposta para imagem maior que 2M

{
"status": "IMAGE_INVALID_SIZE",
"message": "image larger than 2M"
}

Resposta para erro no servidor

{
"status": "INNER_ERROR",
"message": "Inner error, please retry later"
}

Solicitação HTTP

POST https://api.ekycpro.com/v1/gn_ocr/general

Parâmetros da solicitação

parâmetrodescrição
imgstring, imagem codificada em base64. Recomenda-se que a imagem tenha menos de 200KB, para que seja retornada em até 2 segundos, caso contrário, o tempo de retorno será maior.

Formato da resposta

camposdescrição
statuscódigo de status
messagepersonalId: identificação pessoal
surname: sobrenome
firstname: primeiro nome
gender: gênero
nationality: nacionalidade
placeOfIssue: local de emissão
dateOfBirth: data de nascimento
dateOfExpiry: data de validade
dateOfIssue: data de emissão
documentId: identificação do documento

Código de status

statusdescrição
OKcharge, sucesso
FAILcharge, erro no reconhecimento da imagem, por favor verifique a imagem de entrada
INVALID_REQUESTfree, parâmetros de solicitação inválidos
IMAGE_INVALID_FORMATfree, formato de imagem inválido, o formato da imagem deve ser um dos seguintes: jpeg/jpg/png/bmp
IMAGE_INVALID_SIZEfree, tamanho de imagem inválido, deve ser menor que 2M
INNER_ERRORfree, erro no servidor