Pular para o conteúdo

OCR de Passaporte

reconhecimento de passaporte

Exemplo de código:

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

Resposta para reconhecimento de passaporte ID com sucesso

{
"status": "OK",
"message": {
"passportNumber": "E95095047",
"name": "KHOLISATUN NISA",
"gender": "F",
"birthDay": "19891110",
"birthPlace": "SUBANG",
"issueDay": "20170214",
"expiryDay": "20270213",
"issuePlace": "WONOSOBO",
"nationality": "INDONESIA"
}
}

Resposta para reconhecimento de passaporte CN com sucesso

{
"status": "OK",
"message": {
"passportNumber": "E95095047",
"chName": "徐涛涛",
"name": "XU, TAOTA0",
"gender": "M",
"birthDay": "19891110",
"birthPlace": "SHANDONG",
"issueDay": "20170214",
"expiryDay": "20270213",
"issuePlace": "SHANDONG",
"nationality": "CHINESE"
}
}

Resposta para reconhecimento de passaporte PH com sucesso

{
"status": "OK",
"message": {
"passportNumber": "P9603119",
"name": "KHOLISATUN NISA",
"gender": "F",
"birthDay": "19891110",
"birthPlace": "MAKATI MM",
"issueDay": "20170214",
"expiryDay": "20270213",
"nationality": "FILIPINO"
}
}

Resposta para falha no reconhecimento

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

Resposta para tipo não reconhecido

{
"status": "FAIL",
"message": "not a passport""
}

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/pp_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 de resposta para passaporte

camposdescrição
statuscódigo de status
messagepassportNumber: número do passaporte
chName: nome chinês
name: nome
gender: gênero
birthDay: data de nascimento
birthPlace: local de nascimento
issueDay: data de emissão
issuePlace: local de emissão
expiryDay: data de expiração
nationality: nacionalidade

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