API de Tipificação de Documentos
Envio de documentos para tipificação, documentoscopia e OCR, de forma independente de prova de vida, Bureau de Faces e Facematch.
A API de Tipificação de Documentos (Document Only) permite enviar as imagens de um documento e obter a tipificação (identificação do tipo de documento), a documentoscopia (análise de autenticidade) e os dados extraídos (OCR), sem executar nenhuma outra etapa da jornada de validação. A integração é composta por duas chamadas:
- Document Only – envia as imagens do documento.
- Result Only – consulta o resultado do processamento (tipificação, documentoscopia e OCR).
Documentos suportados
São aceitos os tipos de documentos: RG, CNH (física e digital), DNI, CIN, CRNM e Passaporte, incluindo a validação por QR Code na Serpro para a CNH Digital.
Visão geral do fluxo
- Gerar o token de acesso (
/credencial). - Gerar a
appkey(/appkey). - Enviar as imagens do documento (
/document/only). - Receber a notificação de conclusão (webhook).
- Consultar o resultado (
/document/result/only).
Observação!O endereço
https://hml.certiface.com.brdeve ser utilizado apenas para desenvolvimento e homologação. Para o ambiente de produção, substitua-o porhttps://www.certiface.com.br.
1. Credencial
Antes de iniciar, gere o token que será utilizado para criar a appkey. Informe o login e a senha de acesso à integração.
Recomendação: o login e a senha do operador não devem ficar no aplicativo ou no navegador. Gere o token e a appkey a partir do seu servidor.
Request
POST https://hml.certiface.com.br/facecaptcha/service/captcha/credencial| Header | Descrição |
|---|---|
| Content-Type | application/x-www-form-urlencoded |
Body Params
| Parâmetro | Descrição |
|---|---|
| user | Login do operador do Certiface. |
| pass | Senha criptografada em MD5. |
Request example
user: login
pass: 3355a3973f54a008c642ee94fd0313d7Response
| Headers | Descrição |
|---|---|
| Content-Type | application/json |
Body Params
| Body | Descrição |
|---|---|
| token | Token de autorização para gerar appkeys. |
| expires | Horário de expiração do token (UTC-0). |
Responses
| Status Code | Descrição |
|---|---|
| 200 | OK. |
| 400 | Requisição mal formada ou dados não informados corretamente. |
| 401 | Não autorizado ou credenciais expiradas. |
| 500 | Erro genérico. |
Response example
{
"token": "QjBlFoPJZYjSry-H5G3UU_BPSJST1zy8uMSPTtOgr7Y",
"expires": "27/09/2019 19:09:00"
}
É bom saber!
O tipo do conteúdo da requisição deve ser "application/x-www-form-urlencoded".
O token gerado por este método possui expiração configurável. O padrão é de 3 horas. Enquanto o token não expirar, é possível gerar novas appkeys.
2. Appkey
Para utilizar o serviço, crie uma appkey informando os dados do titular do documento (CPF, nome e data de nascimento), o login do operador e o token gerado no passo anterior. A appkey identifica a transação e é utilizada no envio do documento (/document/only) e na consulta do resultado (/document/result/only).
Request
POST https://hml.certiface.com.br/facecaptcha/service/captcha/appkey| Headers | Descrição |
|---|---|
| Content-Type | application/x-www-form-urlencoded |
Body Params
| Parâmetro | Descrição |
|---|---|
| user | Login do operador que gerou as credenciais de acesso. |
| token | Objeto JSON retornado pelo método /credencial (campos token e expires), conforme o exemplo. |
| cpf | CPF do titular do documento. |
| nome | Nome e sobrenome do titular do documento. |
| nascimento | Data de nascimento do titular, no formato dd/mm/yyyy. |
| idExternoCliente | Campo de referência da identificação da proposta/jornada/transação/contrato do cliente. Este id deve ser escrito alfanumérico e conter até 255 caracteres. |
Request example
user: opelogin
token: {"token": "QjBlFoPJZYjSry-H5G3UU_BPSJST1zy8uMSPTtOgr7Y","expires": "27/09/2019 19:09:00"}
cpf: 00000014141
nome: Nome sobrenome
nascimento: 15/11/2001
idExternoCliente: 4561645657446457-651A.SDRFENResponse
| Headers | Descrição |
|---|---|
| Content-Type | application/json |
Body Params
| Campo | Descrição |
|---|---|
| appkey | Chave de acesso da transação. |
Responses
| Status Code | Descrição |
|---|---|
| 200 | OK. |
| 401 | Não autorizado ou credenciais expiradas. |
| 422 | Requisição mal formada ou dados não informados corretamente. |
| 500 | Erro genérico. |
Response example
{
"appkey": "eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJjZXJ0aWZhY2UifQ.u6EaiHfZC9VdEVBNiPqfNVpS38iw"
}
É bom saber!
A appkey gerada por este método possui tempo de expiração configurável. O padrão é de 5 minutos. Ela é utilizada no envio do documento (
/document/only) e na consulta do resultado (/document/result/only).Em homologação, os retornos positivo e negativo da validação Serpro estão limitados a CPFs de teste específicos. Consulte a lista.
3. Document Only (envio do documento)
Envia as imagens do documento para processamento. Este método não exige prova de vida, Bureau de Faces ou Facematch.
Request
POST https://hml.certiface.com.br/facecaptcha/service/captcha/document/only| Headers | Descrição |
|---|---|
| Content-Type | application/json |
Body Params
| Parâmetro | Descrição |
|---|---|
| appkey | Appkey gerada pelo método /appkey. |
| images | Array de imagens do documento em base64, sem o prefixo data:image/...;base64,. Aceita uma ou duas imagens (frente e verso). Formato preferencial: JPEG. |
| qrcode | Utilizado no envio da CNH Digital para validação via Serpro, no lugar de images. Aceita a imagem do QR Code em base64 (JPEG, PNG, GIF ou PDF), o PDF da CNH Digital gerado pelo app CNH Digital em base64, ou o binário do QR Code (codificação ISO-8859-1) enviado em base64. |
Request example
{
"appkey": "eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJjZXJ0aWZhY2UifQ.u6EiPqfNVnPzDill2E5YyYdSpS38iw",
"images": [
"/9j/4AAQSkZJRgABAQ...",
"/9j/4AAQSkZJRgABAQ..."
]
}Response
| Headers | Descrição |
|---|---|
| Content-Type | application/json |
Response Body
| Body | Descrição |
|---|---|
| appkey | Appkey utilizada na requisição. |
| id | Identificação interna. |
Responses
| Status Code | Descrição |
|---|---|
| 200 | OK. Documento recebido para processamento. |
| 400 | Imagem sem documento. Envie outra imagem utilizando a mesma appkey (exiba o alerta de documento não encontrado e volte para a captura do documento). |
| 401 | Não autorizado ou credenciais expiradas (appkey expirada). |
| 500 | Erro genérico. |
Response example
{
"appkey": "eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJjZXJ0aWZhY2UifQ.u6EiPqfNVnPzDill2E5YyYdSpS38iw",
"id": 55
}
É bom saber!
Em todo retorno status code 400, a aplicação deve enviar novas imagens de documento. O procedimento se repete até que o retorno seja status code 200 (OK) ou status code 401 (appkey expirada).
O tempo de expiração da appkey é de 5 minutos.
Formato: preferencialmente JPEG.
O base64 deve ser enviado puro, sem o prefixo
data:image/...;base64,.Não há limite explícito de tamanho por arquivo. A requisição é limitada a 10 MB.
Validação por QR Code (CNH Digital) na Serpro
O Document Only aceita a CNH Digital e realiza a validação por QR Code na Serpro.
Para a validação pelo fluxo da Serpro, envie o campo qrcode no lugar de images. O conteúdo do campo pode ser:
- a imagem do QR Code em base64 (JPEG, PNG, GIF ou PDF);
- o PDF da CNH Digital gerado pelo app CNH Digital, em base64;
- o binário do QR Code, codificado em ISO-8859-1 e enviado em base64.
Request example (QR Code)
{
"appkey": "eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJjZXJ0aWZhY2UifQ.u6EaiHfZC9VdEVBNiPqfNVpS38iw",
"qrcode": "/9j/4AAQSkZJRgABAQ..."
}
HomologaçãoEm homologação, os retornos positivo e negativo da validação Serpro
estão limitados a um conjunto específico de CPFs de teste. Qualquer outro CPF
retorna Serpro não encontrado.Consulte a lista de CPFs de teste
Retorno positivo (validação positiva)
CPF 15929792038 25178629078 34963067005 44707559077 57742988097
Retorno negativo (validação negativa)
CPF 69680042081 77571154006 80277279011 91995827088 07034479046
Demais CPFsQualquer CPF fora das listas acima retorna Serpro não encontrado.
4. Webhook
Ao concluir o processamento do documento, a CertiFace envia uma notificação (webhook) ao endpoint especificado pela empresa. A notificação é uma requisição POST que informa o Status do processamento e a Appkey da transação. Ao recebê-la, consulte o resultado em /document/result/only (seção 5) sem necessidade de espera. Se preferir não utilizar o webhook, consulte o resultado conforme as recomendações da seção 5.
Request
POST https://host/servername/*/| Headers | Descrição |
|---|---|
| Content-Type | application/json |
Body Params
| Body | Descrição |
|---|---|
| Status | Status do processamento: "Completo". |
| Appkey | Appkey da transação, a mesma utilizada no envio do documento (/document/only). |
Request example Status "Completo"
{
"Status": "Completo",
"Appkey": "eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJjZXJ0aWZhY2UifQ.u6EiPqfNVnPzDill2E5YyYdSpS38iw"
}5. Result Only (resultado do documento)
Retorna o resultado do processamento do documento: tipificação, documentoscopia e OCR. Pode ser chamado a qualquer momento após o envio, de preferência após o recebimento do webhook. Caso o status ainda seja "Em processamento", repita a consulta conforme as recomendações do final desta seção.
Request
POST https://hml.certiface.com.br:8443/facecaptcha/service/captcha/document/result/onlyHeader
| Headers | Descrição |
|---|---|
| Content-Type | application/x-www-form-urlencoded |
Body Params
| Parâmetro | Descrição |
|---|---|
| appkey | Appkey utilizada no envio do documento. |
Request example
appkey: eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJjZXJ0aWZhY2UifQ.u6EiPqfNVnPzDill2E5YyYdSpS38iwResponse
| Headers | Descrição |
|---|---|
| Content-Type | application/json |
Response Body
| Body | Descrição |
|---|---|
| status | Status do processamento: "Completo", "Em processamento", "Não processado" ou "Erro". |
| protocolo | Protocolo da transação. |
| dataCriacaoAppkey | Data em que a appkey foi gerada. |
| analiseDocumento | Análise do documento (tipificação, documentoscopia e OCR). Conforme tabela a seguir. |
| fotos | Imagens do documento enviadas. |
Importante!Este retorno traz apenas os dados do documento. Os objetos
certifaceID(Bureau de Faces) efacecaptcha(Prova de Vida) não são retornados, efotoscontém somente as imagens do documento. O objetobiometriaDocumentoé retornado somente quando a validação Serpro é executada (CNH Digital via QR Code), comserpro.codigoeserpro.causa. Quando a validação Serpro não é executada, ele é omitido.
analiseDocumento
| Campo | Descrição |
|---|---|
| idExterno | Código de identificação interna do cliente. |
| ticket | Ticket do(s) documento(s) em processamento. |
| dtCriacao | Data de criação do ticket. |
| statusProcessamento | Status de processamento. Ver tabela abaixo. |
| idTipoProcessamento | Código do tipo de processamento realizado. Código interno. |
| score | Documentoscopia. Valor de 0 a 100% da possibilidade de o documento ser verdadeiro, onde 100% indica que o documento passou com sucesso por todas as regras cadastradas e pelos padrões do estado emissor. |
| responseClientDadosOcrDTO | Dados extraídos do documento, conforme o tipo enviado. |
| documentos | Tipificação. Lista dos documentos processados, com o status e o tipo identificado de cada um. Ver tabelas abaixo. |
| biometriaDocumento | Resultado da validação na Serpro. Retornado apenas quando a validação Serpro é executada. Ver tabela a seguir. |
biometriaDocumento
| Campo | Descrição |
|---|---|
| serpro.codigo | Código da resposta da Serpro. Vide tabela abaixo. |
| serpro.causa | Mensagem referente ao código da resposta. |
O campo serpro.score não é retornado, pois não há validação de similaridade.
serpro.codigo
| serpro.codigo | Descrição |
|---|---|
| 1 | Erros gerais na validação da entrada, itens obrigatórios nulos ou com dados descritos inválidos. |
| 2 | Operador ativo não encontrado. |
| 3 | CPF inválido, formatação ou número. |
| 4 | CPF não cadastrado na base interna. |
| 5 | Arquivo da imagem com formato ou extensão não suportada. |
| 101 | Falha na configuração. Contate o Suporte. |
| 102 | Falha na configuração. Contate o Suporte. |
| 103 | Operador não possui acesso. |
| 200 | Validação Positiva. |
| 250 | QRCode executado. Validação por QR Code realizada com sucesso. |
| 300 | Validação Negativa. |
| 400 | Face não encontrada no documento. |
| 401 | Falha na validação documento-biometria. Falha interna na validação do documento. |
| 402 | Documento ilegível. Recomenda-se nova captura de imagem. |
| 450 | Erro na chamada ou no retorno ao validar documento com a Serpro (inclui erros da Serpro, identificados pelo código DV). |
| 500 | Erro interno. |
Exemplo de biometriaDocumento (CNH Digital via Serpro)
"biometriaDocumento": {
"serpro": {
"codigo": 250,
"causa": "QRCode executado"
}
}statusProcessamento
| Valor | Descrição |
|---|---|
| 2 | Aguardando Processamento. |
| 3 | Em Processamento. |
| 4 | Processado. |
| 5 | Cancelado. |
| 6 | Falha no Processamento. |
| 70 | Upload Incorreto. |
| 100 | Processado sem OCR. |
documentos
| Campo | Descrição |
|---|---|
| arquivo | Número serial, gerado a partir da ordem de recebimento dos arquivos existentes no ticket. |
| statusArquivo | Status de processamento do arquivo. Ver tabela statusArquivo. |
| arquivosProcessado.tipo | Tipo do documento identificado. Ver tabela tipo. |
| arquivosProcessado.statusArquivoProcessado | Status do tipo de documento processado na imagem. Ver tabela statusArquivoProcessado. |
statusArquivo
| Valor | Descrição |
|---|---|
| 7 | Aguardando Identificação. |
| 8 | Falha Identificação. |
| 9 | Sucesso Identificação. |
| 21 | Cancelado. |
| 22 | Processado. |
tipo
| Valor | Descrição |
|---|---|
| 1 | RG[FRONT] |
| 2 | RG[BACK] |
| 4 | CNH[FRONT] |
| 5 | CNH[BACK] |
| 6 | DNI[FRONT] |
| 7 | DNI[BACK] |
| 10 | CNH2022[FRONT] |
| 11 | CNH2022[BACK] |
| 13 | CIN[FRONT] |
| 14 | CIN[BACK] |
| 15 | CRNM[FRONT] |
| 16 | CRNM[BACK] |
| 17 | PASSPORT[FRONT] |
| 18 | PASSPORT[BACK] |
statusArquivoProcessado
| Valor | Descrição |
|---|---|
| 10 | Aguardando Leitura. |
| 11 | Falha Leitura. |
| 12 | Sucesso Leitura. |
| 19 | Processado. |
| 20 | Cancelado. |
fotos
| Campo | Descrição |
|---|---|
| documento[].descricao | Identificação da imagem: FACE A, FACE B ou CNH DIGITAL. |
| documento[].imagem | Imagem do documento em base64. |
CNH DigitalQuando o fluxo CNH Digital + Serpro é executado, ou quando a CNH Digital é enviada em PDF, o array
fotos.documentoretorna também um item com a descriçãoCNH DIGITAL:{ "descricao": "CNH DIGITAL", "imagem": "BASE64" }
Response example
{
"status": "Completo",
"protocolo": 60260000000148,
"analiseDocumento": {
"idExterno": "622e22a6-0304-45cd-9e55-f99e41943106",
"ticket": "c41739f1-0143-4cb9-b6db-d54dedbeca64",
"dtCriacao": "2026-11-05T13:57:05.415Z",
"statusProcessamento": 4,
"idTipoProcessamento": 2,
"score": 100,
"responseClientDadosOcrDTO": {
"responseClientRGOcrDTO": {
"estado": "SP",
"documento": "RG",
"dtExpedicao": "01/01/2001",
"dtExpedicaoFormatada": "2001-01-01",
"nrRg": "123456781",
"nome": "NOME SOBRENOME",
"filiacao": "NOME DA MAE NOME DO PAI",
"dtNascimento": "01/01/2001",
"dtNascimentoFormatada": "2001-01-01",
"cpf": "12345678900",
"naturalidade": "CIDADE",
"nomenclatura": "EMISSORUF",
"nomePai": "NOME DO PAI",
"nomeMae": "NOME DA MAE",
"pretoEBranco": "false"
}
},
"documentos": [
{
"arquivo": 2,
"statusArquivo": 22,
"arquivosProcessado": [
{ "tipo": 2, "statusArquivoProcessado": 19 }
]
},
{
"arquivo": 1,
"statusArquivo": 22,
"arquivosProcessado": [
{ "tipo": 1, "statusArquivoProcessado": 19 }
]
}
]
},
"dataCriacaoAppkey": "2026-11-05 10:56:52",
"fotos": {
"documento": [
{ "descricao": "FACE A", "imagem": "/9j/..." },
{ "descricao": "FACE B", "imagem": "/9j/..." }
]
}
}Responses
| Status Code | Descrição |
|---|---|
| 200 | OK. |
| 400 | Requisição mal formada ou dados não informados corretamente. |
| 401 | Não autorizado ou credenciais expiradas. |
| 404 | Appkey não encontrada ou documento não enviado. |
| 500 | Erro genérico. |
É bom saber!
Após receber o webhook, a consulta pode ser feita sem espera.
Se não aguardar o webhook, aguarde de 30 a 60 segundos após o retorno do
/document/onlypara a primeira consulta. Entre consultas, aguarde pelo menos 1 minuto.Quando o status retornar "Erro" ou "Não processado", inicie uma nova jornada: gere uma nova appkey e envie o documento novamente. Em caso de "Upload Incorreto" (
statusProcessamento70), solicite a recaptura do documento.
6. Dados extraídos por tipo de documento
O objeto responseClientDadosOcrDTO traz apenas o bloco correspondente ao documento enviado (RG, CNH, DNI, CIN, CRNM ou Passaporte); os demais são suprimidos.
responseClientRGOcrDTO
| responseClientRGOcrDTO | Descrição |
|---|---|
| estado | Estado onde foi emitido o documento. |
| documento | Tipo do documento. |
| dtExpedicao | Data de expedição (dd/mm/yyyy). |
| dtExpedicaoFormatada | Data de expedição (yyyy-mm-dd). |
| nrRg | Número do RG. |
| nome | Nome e sobrenome do titular. |
| filiacao | Nome do pai e da mãe. |
| nomePai | Nome do pai. |
| nomeMae | Nome da mãe. |
| docOrigem | Origem do documento. |
| dtNascimento | Data de nascimento (dd/mm/yyyy). |
| dtNascimentoFormatada | Data de nascimento (yyyy-mm-dd). |
| cpf | Número do CPF. |
| naturalidade | Naturalidade. |
| nomenclatura | Nome do órgão emissor. |
| dtCriacao | Data de criação do processo (yyyy-mm-dd hh:mm:ss). |
| flAnalfabeto | Indica se o documento não possui assinatura do titular. true = não assinado; false = assinado. |
| pretoEBranco | Indica se a imagem está em preto e branco (true/false). |
ResponseClientCNHOcrDTO
| ResponseClientCNHOcrDTO | Descrição |
|---|---|
| estado | Sigla do estado de emissão. |
| estadoNome | Nome do estado de emissão. |
| documento | Tipo do documento (CNH). |
| nome | Nome e sobrenome do titular. |
| docOrigem | Documento de origem: número e emissor. |
| documentoOrigem | Número do documento de origem. |
| emissorOrigem | Emissor de origem. |
| ufOrigem | UF de origem. |
| cpf | Número do CPF. |
| dtNascimento | Data de nascimento (dd/mm/yyyy). |
| dtNascimentoFormatada | Data de nascimento (yyyy-mm-dd). |
| filiacao | Nome do pai e da mãe. |
| nomePai | Nome do pai. |
| nomeMae | Nome da mãe. |
| permissao | "PERMISSÃO" ou NULL. |
| acc | Autorização para conduzir ciclomotores. |
| categoria | Categoria ("ABCDE" ou individual). |
| numeroRegistro | Número de registro do documento. |
| validade | Data de validade (dd/mm/yyyy). |
| primeiraHabilitacao | Data da primeira habilitação (dd/mm/yyyy). |
| local | Cidade e estado de emissão. |
| dtExpedicao | Data de expedição (dd/mm/yyyy). |
| dtExpedicaoFormatada | Data de expedição (yyyy-mm-dd). |
| codSeguranca | Código de segurança. |
| espelho | Número de controle do documento. |
| renach | Numeração do Renach. |
| dtCriacao | Data de criação do processo (yyyy-mm-dd hh:mm:ss). |
| pretoEBranco | Indica se a imagem está em preto e branco (true/false). |
| formato | Retornado para CNH física ou digital (ex.: QRCode, Foto). |
| extensao | Retornado para CNH física ou digital (ex.: Imagem, PDF, Binário). |
ResponseClientDNIOcrDTO
| ResponseClientDNIOcrDTO | Descrição |
|---|---|
| estado | Estado de emissão. |
| nomenclatura | Nome do órgão emissor. |
| naturalidade | Naturalidade. |
| filiacao | Nome do pai e da mãe. |
| nomePai | Nome do pai. |
| nomeMae | Nome da mãe. |
| dtNascimento | Data de nascimento (dd/mm/yyyy). |
| dtNascimentoFormatada | Data de nascimento (yyyy-mm-dd). |
| nome | Nome e sobrenome do titular. |
| observacaoFront | Observação. |
| outroRG | Número de outro RG, caso possua. |
| orgao | Órgão emissor. |
| fator | Tipo sanguíneo com fator Rh. |
| registroCivil | Informação de origem do registro civil. |
| cnh | Número da CNH. |
| cns | Cartão Nacional de Saúde. |
| cpf | Número do CPF. |
| ctps | Número da Carteira de Trabalho. |
| serieCTPS | Série da Carteira de Trabalho. |
| ufctps | UF de emissão da Carteira de Trabalho. |
| dni | Número do DNI. |
| tituloEleitor | Número do Título de Eleitor. |
| dtExpedicao | Data de expedição (dd/mm/yyyy). |
| dtExpedicaoFormatada | Data de expedição (yyyy-mm-dd). |
| local | Posto onde o DNI foi emitido. |
| certMilitar | Número da Certidão Militar. |
| nomeSocial | Nome social. |
| pis | Número do PIS. |
| profissional | Identidade profissional ou CIP. |
| rg | Número do RG. |
| dtCriacao | Data de criação do processo (yyyy-mm-dd hh:mm:ss). |
| flAnalfabeto | true = documento não assinado; false = assinado. |
| pretoEBranco | Indica se a imagem está em preto e branco (true/false). |
ResponseClientCINOcrDTO
| ResponseClientCINOcrDTO | Descrição |
|---|---|
| documento | Tipo do documento (CIN). |
| estado | Estado de emissão. |
| nomenclatura | Nome do órgão emissor. |
| nome | Nome e sobrenome do titular. |
| cpf | Número do CPF. |
| sexo | Gênero do titular. |
| dtNascimento | Data de nascimento (dd/mm/yyyy). |
| dtNascimentoFormatada | Data de nascimento (yyyy-mm-dd). |
| nacionalidade | Nacionalidade. |
| naturalidade | Naturalidade. |
| dtValidade | Data de validade do documento. |
| posto | Local de emissão. |
| filiacao | Nome do pai e da mãe. |
| nomePai | Nome do pai. |
| nomeMae | Nome da mãe. |
| orgaoEmissor | Órgão emissor. |
| local | Estado onde foi emitido o documento. |
| dtExpedicao | Data de expedição (dd/mm/yyyy). |
| dtExpedicaoFormatada | Data de expedição (yyyy-mm-dd). |
| analfabeto | true = documento não assinado; false = assinado. |
| dtCriacao | Data e hora do envio do documento (yyyy-mm-dd hh:mm:ss). |
| pretoEBranco | Indica se a imagem está em preto e branco (true/false). |
ResponseClientOcrDTO (CRNM)
| ResponseClientOcrDTO | Descrição |
|---|---|
| documento | Tipo do documento (CRNM). |
| nome | Nome e sobrenome do titular. |
| cpf | Número do CPF. |
| nrRnm | Número do registro RNM (Registro Nacional Migratório). |
| dtNascimento | Data de nascimento (dd/mm/yyyy). |
| sexo | Gênero do titular. |
| dtExpiracao | Data de validade do documento. |
| nomePais | Nome do pai. |
| nacionalidade | País de nacionalidade do titular. |
| autoridadeEmissora | Órgão responsável pela emissão. |
| classificacao | Classificação migratória (ex.: residente). |
| pretoEBranco | Indica se a imagem está em preto e branco (true/false). |
ResponseClientOcrDTO (Passaporte)
| ResponseClientOcrDTO | Descrição |
|---|---|
| documento | Tipo do documento (Passaporte). |
| nome | Nome e sobrenome do titular. |
| cpf | Número do CPF. |
| nrPassaporte | Número do passaporte. |
| dtNascimento | Data de nascimento (dd/mm/yyyy). |
| sexo | Gênero do titular. |
| dtExpedicao | Data de expedição. |
| nacionalidade | País de nacionalidade do titular. |
| autoridadeEmissora | Órgão responsável pela emissão. |
| paisEmissor | País emissor do passaporte. |
| tpPassaport | Tipo do passaporte (comum, diplomático, oficial etc.). |
| naturalidade | Cidade ou local de nascimento do titular. |
| pretoEBranco | Indica se a imagem está em preto e branco (true/false). |
Outros Retornos
Nome Inválido
{
"status": "ERR",
"resultado": "ERR",
"protocolo": "202001138311",
"msg": "NOME"
}CPF Inválido
{
"status": "ERR",
"resultado": "ERR",
"protocolo": "202001138315",
"msg": "INVALID CPF"
}Nascimento Inválido
{
"status": "ERR",
"resultado": "ERR",
"protocolo": "202001138317",
"msg": "INVALID DATE"
}Updated about 5 hours ago
