Pular para o conteúdo

OCR de Carteira de Identidade do México

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

Exemplo de código:

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

Resposta para sucesso no reconhecimento da frente do cartão

{
"status": "OK",
"message": {
"gender": "M",
"idNumber": "MONY801107MTSLRR07",
"voterId": "MLNRYR80110728M300",
"fullName": "MOLINA NORATO YURI YERANIA",
"fatherLastName": "MOLINA",
"motherLastName": "NORATO",
"name": "YURI YERANIA",
"birthday": "15/07/1987",
"issueYear": "2011",
"expiryYear": "2021",
"registrationYearAndMonth": "200101",
"municipalNumber": "041",
"postalCode": "87040",
"placeNumber": "0001",
"stateNumber": "28",
"state": "TAMPS",
"district": "VICTORIA",
"subDistrict": "FRACC EL MIRADOR",
"addressAll": "AND 8 1121 INF ALDAMA 87040 VICTORIA ,TAMPS."
}
}

Resposta para sucesso no reconhecimento do verso do cartão

{
"status": "OK",
"message": {
"idNumber": "",
"fullName": "JTMENEZ HERNANDEZ ADRTANA",
"fatherLastName": "JTMENEZ",
"motherLastName": "HERNANDEZ",
"name": "ADRTANA",
"birthday": "16/03/1970",
"gender": "M",
"expiryYear": "2032",
"issueYear": "2022",
"voterId": "",
"placeNumber": "",
"stateNumber": "",
"municipalNumber": "",
"state": "",
"district": "",
"subDistrict": "",
"addressAll": "",
"postalCode": "",
"registrationYearAndMonth": ""
}
}

Resposta para falha no reconhecimento

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

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 do servidor

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

Solicitação HTTP

POST https://api.ekycpro.com/v1/mx_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
messageidNumber: número de identificação
fullName: nome completo
fatherLastName: sobrenome do pai
motherLastName: sobrenome da mãe
name: nome
birthday: data de nascimento
gender: gênero
expiryYear: ano de expiração
issueYear: ano de emissão
voterId: número de eleitor
placeNumber: número do local
stateNumber: número do estado
municipalNumber: número do município
state: estado
district: distrito
subDistrict: subdistrito
addressAll: endereço
postalCode: código postal
registrationYearAndMonth: ano e mês de registro

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 jpeg/jpg/png/bmp
IMAGE_INVALID_SIZEfree, tamanho de imagem inválido, deve ser menor que 2M
INNER_ERRORfree, erro do servidor