> For the complete documentation index, see [llms.txt](https://docs.caf.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.caf.io/caf-api/caf-api-pt-br/connect/transactions/services/document-ocr.md). # OCR de documento Reconhecimento Óptico de Caracteres - extração de dados de documentos enviados. **Seção**: `ocr` **Arquivos obrigatórios:** `quaisquer imagens de documentos` #### Atributos específicos (RG) {% tabs %} {% tab title="Esquema" %} | Atributo | Tipo | Descrição | | ----------------------------- | ------ | -------------------------------- | | unidade federativa | String | Estado | | rg | String | RG | | via | String | | | dataDeEmissão | String | Data de emissão | | name | String | Nome | | nomeDoPai | String | Nome do pai | | nomeDaMãe | String | Nome da mãe | | localDeNascimento | String | Local de nascimento | | birthDate | String | Data de nascimento | | documentoDeReferência | String | Fonte do documento | | cpf | String | CPF | | estadoDeEmissão | String | Estado de emissão | | órgãoEmissor | String | Órgão emissor | | órgão emissor do RG | String | Órgão emissor do RG | | ufDeEmissãoDoRG | String | Estado de emissão do RG | | departamento | String | Departamento | | tipoDeDocumentoDaFrenteDoRG | String | Tipo de documento | | rodapéDoVersoDoRG | String | Rodapé do verso do RG | | nomeGráfico | String | Nome gráfico | | cabeçalhoDaFrenteDoRG | String | Cabeçalho da frente do RG | | instituto | String | Instituto | | cabeçalhoDaAutoridadeEmissora | String | Cabeçalho da autoridade emissora | | leiNoVersoDoRG | String | Lei no verso do RG | | separadorDosPais | String | Separador dos pais | | {% endtab %} | | | {% tab title="Exemplo" %} ```json { "ocr": { "federativeUnit": "ESTADO DA BAHIA", "rg": "00.000.000-00", "via": "", "issueDate": "13/04/2015", "name": "JANE DOE", "fatherName": "JOHN DOE", "motherName": "MARIA DOE", "birthPlace": "JAGUAQUARA BA", "birthDate": "25/02/1952", "referenceDocument": "C.NAS. CM JAGUAQUARA BA", "cpf": "00000000000", "issueState": "BA", "issuingAuthority": "SSP", "rgIssuingAuthority": "SSP", "rgIssueState": "BA", "department": "SPTC / DEPARTAMENTO DE IDENTIFICACAO", "documentTypeRgFront": "CARTEIRA DE IDENTIDADE", "footerRgBack": "", "graphicName": "THOMAS GREG & SONS", "headerRgFront": "REPUBLICA FEDERATIVA DO BRASIL", "institute": "POLICIA CIVIL", "issuingAuthorityHeader": "SECRETARIA DE ESTADO DE SEGURANCA PUBLICA", "lawRgBack": "LEI NO 7.116 DE 29/08/83", "parentsSeparator": "E" } } ``` {% endtab %} {% tab title="Regras de validação" %} | Regra | Descrição | | ------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ | | is\_readable | Verifica se os documentos estão legíveis | | is\_cnh | Verifica se o documento enviado é uma CNH | | has\_cpf | Verifica se a transação tem um CPF (lido pelo OCR ou inserido manualmente) | | cnh\_has\_valid\_date | Verifica se a data de validade da CNH não está vencida | | data\_de\_emissao\_valida | Verifica se a data de emissão do documento é válida. | | numero\_de\_cpf\_valido | Verifica se o número do CPF é válido | | numero\_rg\_valido | Verifica se o número do RG é válido. | | numero\_de\_registro\_cnh\_valido | Verifica se o número de registro da CNH é válido. | | orgao\_emissor\_rg\_valido | Verifica se o órgão emissor do RG é válido. | | estado\_de\_emissao\_valido | Verifica se a UF do órgão emissor do documento é válida. | | parâmetros\_e\_documento\_são\_iguais | Verifica se há divergências entre os dados do documento e os inseridos manualmente. | | ocr\_equals\_parameters | A regra será inválida se as informações fornecidas nos parâmetros e lidas pelo OCR forem diferentes. | | rg\_emitido\_ha\_menos\_de\_25\_anos | A regra será inválida se o tipo de documento RG tiver sido emitido há mais de 25 anos. | | is\_literate | A regra será inválida se o OCR identificar que o documento pertence a uma pessoa não alfabetizada. | | rg\_tem\_cpf | A regra será inválida se o tipo de documento RG não tiver o campo CPF preenchido. | | company\_qsa\_data\_compatibility | A regra será inválida se o nome e o CPF dos sócios enviados no onboarding de PJ forem diferentes dos do onboarding de PF. | | data\_and\_document\_are\_equal | A regra será inválida se houver divergência entre as informações do parâmetro e o OCR. | | has\_cnh\_for\_more\_than\_three\_years | A regra será inválida se o motorista tiver menos de 3 anos de habilitação. | | has\_definitive\_cnh | A regra será inválida se o motorista não tiver habilitação definitiva. | | document\_issue\_less\_than\_10 | A regra será inválida se o documento tiver sido emitido há mais de 10 anos. | | issued\_over\_16\_years | Verifica se a diferença entre a data de nascimento e a emissão do documento de identidade é maior ou igual a 16 anos. | | first\_and\_last\_name\_similarity | Verifica a semelhança entre a união do nome e sobrenome enviados nos parâmetros em comparação com a união do nome e de cada sobrenome na origem. | | is\_passport | A regra será inválida se o documento não for um passaporte. | | is\_not\_passport | A regra será inválida se o documento for um passaporte. | | is\_not\_ctps | A regra será inválida se o documento não for uma carteira de trabalho. | | document\_is\_known | A regra será inválida se o documento for categorizado como "outros", "null" ou "inválido". | | parâmetros\_e\_documento\_indefinidos\_ou\_iguais | Verifica a inexistência ou divergência entre os dados do documento e os dados inseridos manualmente. | | invalid\_range\_ages | Verifica se o titular do CPF está dentro da faixa etária configurada. | | ocr\_over\_18 | Verifica se a idade no documento é menor que 18 anos. | | {% endtab %} | | | {% endtabs %} | | #### Atributos específicos (CNH) {% tabs %} {% tab title="Esquema" %} | Atributo | Tipo | Descrição | | ------------------------- | ------ | ------------------------------------ | | birthDate | String | Data de nascimento | | cpf | String | CPF | | name | String | Nome | | nomeDaMãe | String | Nome da mãe | | nomeDoPai | String | Nome do pai | | dataDeEmissão | String | Data de emissão | | rg | String | RG | | ufDeEmissãoDoRG | String | UF de emissão do RG | | órgão emissor do RG | String | órgão emissor do RG | | acc | String | Autorização para conduzir ciclomotor | | categoria | String | Categoria da CNH | | dataDaPrimeiraHabilitação | String | Data da sua primeira habilitação | | localDeEmissão | String | Local onde a CNH foi emitida | | númeroDoEspelho | String | Número do espelho da CNH | | númeroDeRegistro | String | Número de registro da CNH | | númeroRENACH | String | Número RENACH | | númeroDeSegurança | String | Número de segurança | | observações | String | Observações | | dataDeValidade | String | Data de validade | | ufDeEmissãoDaCNH | String | UF de emissão da CNH | | {% endtab %} | | | {% tab title="Exemplo" %} ```json { "ocr": { "name": "JANE DOE", "rg": "00XXXXXXX99", "rgIssuingAuthority": "SSP", "rgIssueState": "RS", "cpf": "00000000000", "birthDate": "08/05/1999", "fatherName": "JOHN DOE", "motherName": "MARIA DOE", "acc": "", "category": "AB", "registrationNumber": "06XXXXXXX02", "expirationDate": "07/05/2032", "firstDriverLicenseDate": "26/07/2017", "mirrorNumber": "23XXXXXX51", "notes": "", "placeOfIssue": "PORTO ALEGRE, RS", "issueDate": "07/05/2022", "securityNumber": "02XXXXXXX60", "renachNumber": "RSXXXXXX070", "cnhIssueState": "RS" } } ``` {% endtab %} {% endtabs %} #### Atributos específicos (CRLV) {% tabs %} {% tab title="Esquema" %} | Atributo | Tipo | Descrição | | ------------------ | ------ | --------------------- | | estadoDeEmissão | String | UF de emissão | | númeroDoCRLV | String | Número do CRLV | | via | String | Via | | códigoRENAVAM | String | Código Renavam | | RNTRC | String | RNTRC | | anoDeAtribuição | String | Ano de atribuição | | name | String | Nome | | cpf | String | CPF | | cnpj | String | CNPJ | | placa | String | Placa | | placaEUfAnteriores | String | Placa e UF anteriores | | chassi | String | Chassi | | tipo | String | Tipo | | combustível | String | Combustível | | marcaEModelo | String | Marca e modelo | | anoDeFabricação | String | Ano de fabricação | | anoDoModelo | String | Ano do modelo | | potênciaCilindrada | String | Potência/cilindrada | | categoria | String | Categoria | | corPredominante | String | Cor predominante | | dataDeEmissão | String | Data de emissão | | {% endtab %} | | | {% tab title="Exemplo" %} ```json { "ocr": { "issueState": "SC", "crlvNumber": "00000000000000", "via": "", "renavamCode": "00000000000", "rntrc": "", "assignmentYear": "2017", "name": "CAF", "cpf": "", "cnpj": "0000000000000000", "plate": "00000", "previousPlateAndState": "000000", "chassis": "000000000000000000000000", "type": "PAS/AUTOMOVEL", "fuel": "", "brandAndModel": "VW/VOYAGE CL MB", "manufactureYear": "2014", "modelYear": "2015", "capacityPowerCylinders": "5P/104CV", "category": "ALCO/GASOL OFICIAL", "predominantColor": "PRATA", "issueDate": "20/07/2017" } } ``` {% endtab %} {% endtabs %} #### Atributos específicos (CTPS) {% tabs %} {% tab title="Esquema" %} | Atributo | Tipo | Descrição | | --------------------- | ------ | ----------------------- | | PIS/PASEP | String | PIS/PASEP | | númeroDoDocumento | String | Número do documento | | sérieDoDocumento | String | Série do documento | | unidade federativa | String | Unidade federativa | | name | String | Nome | | nomeDaMãe | String | Nome da mãe | | nomeDoPai | String | Nome do pai | | birthDate | String | Data de nascimento | | estadoCivil | String | Estado civil | | documentoDeReferência | String | Documento de referência | | cpf | String | CPF | | localDeEmissão | String | Local de emissão | | dataDeEmissão | String | Data de emissão | | {% endtab %} | | | {% tab title="Exemplo" %} ```json { "ocr": { "pisPasep": "0000000000000", "documentNumber": "00000000", "documentSeries": "0000", "federativeUnit": "MG", "name": "JANE DOE", "motherName": "JOHN DOE", "fatherName": "MARIA DOE", "birthDate": "02/08/1979", "maritalStatus": "SOLTEIRO", "birthPlace": "BELO HORIZONTE - MG", "referenceDocument": "C. I. MG 000000 19/11/2004 PC MG", "cpf": "00000000000000", "issuePlace": "SRTE/MG -", "issueDate": "18/05/2015" } } ``` {% endtab %} {% endtabs %} #### Atributos específicos (RNE) {% tabs %} {% tab title="Esquema" %} | Atributo | Tipo | Descrição | | ------------- | ------ | ------------------ | | birthDate | String | Data de nascimento | | classificação | String | Classificação | | dataDeEntrada | String | Data de entrada | | nomeDoPai | String | Nome do pai | | sexo | String | Sexo | | dataDeEmissão | String | Data de emissão | | órgãoEmissor | String | Órgão emissor | | proteçãoLegal | String | Proteção legal | | nomeDaMãe | String | Nome da mãe | | mrz | String | MRZ | | name | String | Nome | | nacionalidade | String | Nacionalidade | | paísDeOrigem | String | País de origem | | rne | String | RNE | | validade | String | Validade | | via | String | Via | | {% endtab %} | | | {% tab title="Exemplo" %} ```json { "ocr": { "birthDate": "01/11/1988", "classification": "PERMANENTE", "entryDate": "31/08/2011", "fatherName": "JOHN DOE", "gender": "M", "issueDate": "17/11/2017", "issuingAuthority": "CGPI/DIREX/DPF", "legalProtection": "", "motherName": "MARIE DOE", "mrz": "", "name": "JAMES DEE", "nationality": "ANGOLANA", "nativeCountry": "ANGOLA", "rne": "0000000", "validity": "06/11/2026", "via": "1" } } ``` {% endtab %} {% endtabs %} #### Atributos específicos (RNM) {% tabs %} {% tab title="Esquema" %} | Atributo | Tipo | Descrição | | ----------------- | ------ | ------------------- | | birthDate | String | Data de nascimento | | classificação | String | Classificação | | cpf | String | CPF | | nomeDoPai | String | Nome do pai | | sexo | String | Sexo | | dataDeEmissão | String | Data de emissão | | órgãoEmissor | String | Órgão emissor | | proteçãoLegal | String | Proteção legal | | nomeDaMãe | String | Nome da mãe | | mrz | String | MRZ | | name | String | Nome | | nacionalidade | String | Nacionalidade | | protocolo | String | Protocolo | | prazoDeResidência | String | Prazo de residência | | rnm | String | RNM | | validade | String | Validade | | {% endtab %} | | | {% tab title="Exemplo" %} ```json { "ocr": { "birthDate": "30/05/1989", "classification": "TEMPORARIO", "cpf": "0000000000", "fatherName": "MARIE DEE", "gender": "M", "issueDate": "22/01/2019", "issuingAuthority": "CGPI/DIREX/PF", "legalProtection": "ART. 14. I. LETRA C DA LEI 13.445/2017.", "motherName": "ROSEMOND DEE", "mrz": "<<<<<<<<< 000 <<<<<<<<<< 0 000", "name": "JEAN DEE", "nationality": "HAITI", "protocol": "", "residenceTerm": "22/10/2020", "rnm": "000000000", "validity": "22/10/2020" } } ``` {% endtab %} {% endtabs %} #### Atributos específicos (PASSAPORTE) {% tabs %} {% tab title="Esquema" %} | Atributo | Tipo | Descrição | | -------------- | ------ | ------------------- | | birthDate | String | Data de nascimento | | dataDeValidade | String | Data de validade | | númeroDaFrente | String | Número da frente | | sexo | String | Sexo | | dataDeEmissão | String | Data de emissão | | órgãoEmissor | String | Autoridade emissora | | paísEmissor | String | País emissor | | nomeDaMãe | String | Nome da mãe | | mrz | String | MRZ | | name | String | Nome | | nacionalidade | String | Nacionalidade | | naturalidade | String | Nacionalidade | | número | String | Number | | tipo | String | Tipo | | {% endtab %} | | | {% tab title="Exemplo" %} ```json { "ocr": { "birthDate": "23/07/1982", "expirationDate": "05/06/2027", "fatherName": "JOSE DEE", "front_number": "000000", "gender": "M", "issueDate": "06/06/2017", "issuingAuthority": "DPF/CAS/SP", "issuingCountry": "BRA", "motherName": "MARIA DEE", "mrz": "0<000<000<000 << 000<000 <<<<<<<<<<<<<< 00000<000000 <<<<<<<<<<<<<< 00", "name": "JOSE DEE JUNIOR", "nationality": "BRASILEIRO(A)", "naturality": "MARILIA/SP", "number": "00000", "type": "P" } } ``` {% endtab %} {% endtabs %} #### Atributos específicos (NOVO CRLV) {% tabs %} {% tab title="Esquema" %} | Atributo | Tipo | Descrição | | ---------------------- | ------ | -------------------------- | | anoDeAtribuição | String | Ano de atribuição | | eixos | String | Eixos | | carroceria | String | Carroceria | | marca e modelo | String | Marca e modelo | | capacidadeEmPessoas | String | Capacidade em pessoas | | capacidadeEmPeso | String | Capacidade em peso | | potênciaCilindrada | String | Potência/cilindrada | | cat | String | Cat | | categoria | String | Categoria | | chassi | String | Chassi | | númeroDeSegurançaDaCLA | String | Número de segurança da CLA | | cmt | String | CMT | | cnpj | String | CNPJ | | cpf | String | CPF | | cpfMask | String | Máscara do CPF | | númeroDoCRLV | String | Número do CRLV | | crvNumber | String | Número do CRV | | combustível | String | Combustível | | issueAuthority | String | Autoridade emissora | | dataDeEmissão | String | Data de emissão | | localDeEmissão | String | Local de emissão | | estadoDeEmissão | String | UF de emissão | | anoDeFabricação | String | Ano de fabricação | | anoDoModelo | String | Ano do modelo | | motor | String | Motor | | name | String | Nome | | placa | String | Placa | | corPredominante | String | Cor predominante | | placaEUfAnteriores | String | Placa e UF anteriores | | códigoRENAVAM | String | Código Renavam | | tipo | String | Tipo | | vehicleObservations | String | Observações do veículo | | {% endtab %} | | | {% tab title="Exemplo" %} ```json { "ocr": { "assignmentYear": "", "axles": "3", "body": "NÃO APLICÁVEL CARROCERIA ABERTA", "brandAndModel": "SR/RANDON SR CA", "capacityInPeople": "00P", "capacityInWeight": "26.0", "capacityPowerCylinders": "0CV/****", "cat": "", "category": "BRANCA", "chassis": "00000000000000", "claSecurityNumber": "", "cmt": "*.*", "cnpj": "00000000000000", "cpf": "", "cpfMask": "", "crlvNumber": "", "crvNumber": "", "fuel": "", "issueAuthority": "DETRAN-GO", "issueDate": "06/04/2020", "issuePlace": "RIO VERDE GO", "issueState": "GO", "manufactureYear": "", "modelYear": "", "motor": "0000000000000", "name": "CAF", "plate": "", "predominantColor": "", "previousPlateAndState": "00000/MT", "renavamCode": "", "type": "SEMI-REBOQUE", "vehicleObservations": "" } } ``` {% endtab %} {% endtabs %} #### Atributos específicos (NOVA CNH) {% tabs %} {% tab title="Esquema" %} | Atributo | Tipo | Descrição | | ------------------------- | ------ | ------------------------------------ | | name | String | Nome | | dataDaPrimeiraHabilitação | String | Data da primeira CNH | | birthDate | String | Data de nascimento | | localDeNascimento | String | Local de nascimento | | birthState | String | Estado de nascimento | | birthDateCityState | String | Data de nascimento, cidade e estado | | dataDeEmissão | String | Data de emissão | | dataDeValidade | String | Data de validade | | acc | String | ACC | | definitiveOrPermissionary | String | Definitivo ou permissionário | | rg | String | RG | | rgMask | String | Máscara do RG | | órgão emissor do RG | String | rgIssuingAuthority | | ufDeEmissãoDoRG | String | Estado de emissão do RG | | rgNumberAuthorityState | String | Estado do número da autoridade do RG | | cpf | String | CPF | | cpfMask | String | Máscara do CPF | | númeroDeRegistro | String | Número de registro | | categoria | String | Categoria | | nacionalidade | String | Nacionalidade | | nomeDoPai | String | Nome do pai | | nomeDaMãe | String | Nome da mãe | | númeroDoEspelho | String | Número espelho | | observações | String | Observações | | localDeEmissão | String | Local de emissão | | númeroDeSegurança | String | Número de segurança | | númeroRENACH | String | Número RENACH | | ufDeEmissãoDaCNH | String | UF de emissão da CNH | | {% endtab %} | | | {% tab title="Exemplo" %} ```json { "ocr": { "name": "EDIO DEE", "firstDriverLicenseDate": "24/04/1985", "birthDate": "27/09/1966", "birthPlace": "BLUMENAU", "birthState": "SC", "birthDateCityState": "27/09/1966 BLUMENAU/SC", "issueDate": "30/06/2022", "expirationDate": "09/06/2027", "acc": "", "definitiveOrPermissionary": "D", "rg": "00000000", "rgMask": "9999999", "rgIssuingAuthority": "SSP", "rgIssueState": "SC", "rgNumberAuthorityState": "000000 SSP SC", "cpf": "00000000000", "cpfMask": "999.999.999-99", "registrationNumber": "0000000000000", "category": "AB", "nationality": "BRASILEIRO", "fatherName": "WALTER DEE", "motherName": "INGELORE DEE", "mirrorNumber": "000000000000000", "notes": "", "placeOfIssue": "FLORIANOPOLIS, SC", "securityNumber": "000000000000", "renachNumber": "SC00000000", "cnhIssueState": "SC" } } ``` {% endtab %} {% endtabs %} #### Atributos específicos (NOVO RG) {% tabs %} {% tab title="Esquema" %} | Atributo | Tipo | Descrição | | ----------------------------- | ------ | -------------------------------- | | birthDate | String | Data de nascimento | | localDeNascimento | String | Local de nascimento | | cpf | String | CPF | | cpfMask | String | Máscara do CPF | | departamento | String | Departamento | | tipoDeDocumentoDaFrenteDoRG | String | Documento tipo RG frente | | dataDeValidade | String | Data de validade | | nomeDoPai | String | Nome do pai | | unidade federativa | String | Unidade federativa | | rodapéDoVersoDoRG | String | Rodapé RG verso | | nomeGráfico | String | Nome gráfico | | cabeçalhoDaFrenteDoRG | String | Cabeçalho da frente do RG | | instituto | String | Instituto | | dataDeEmissão | String | Data de emissão | | estadoDeEmissão | String | UF de emissão | | órgãoEmissor | String | Órgão emissor | | cabeçalhoDaAutoridadeEmissora | String | Cabeçalho da autoridade emissora | | leiNoVersoDoRG | String | Lei RG verso | | nomeDaMãe | String | Nome da mãe | | name | String | Nome | | separadorDosPais | String | Separador dos pais | | documentoDeReferência | String | Documento de referência | | rg | String | RG | | ufDeEmissãoDoRG | String | Estado de emissão do RG | | órgão emissor do RG | String | Autoridade emissora do RG | | rgMask | String | Máscara do RG | | via | String | Via | | {% endtab %} | | | {% tab title="Exemplo" %} ```json { "ocr": { "birthDate": "27/07/1978", "birthPlace": "GUARULHOS - SP", "cpf": "00000000000", "cpfMask": "999999999/99", "department": "", "documentTypeRgFront": "CARTEIRA DE IDENTIDADE", "expirationDate": "01/01/2030", "fatherName": "JOHN DEE", "federativeUnit": "ESTADO DE SÃO PAULO", "footerRgBack": "VAL", "graphicName": "VALI5", "headerRgFront": "REPUBLICA FEDERATIVA DO BRASIL", "institute": "INSTITUTO DE IDENTIFICAÇÃO 'RICARDO GUMBLETON DAUNT'", "issueDate": "06/01/2020", "issueState": "SP", "issuingAuthority": "SSP-SP", "issuingAuthorityHeader": "SIPA SECRETARIA DA SEGURANÇA PÚBLICA", "lawRgBack": "LEINO 7.116, DE 29 DE AGOSTO DE 1983", "motherName": "MARIA DEE", "name": "REIS DEE", "parentsSeparator": "", "referenceDocument": "GUARULHOS - SP 1.SUBDISTRITO CC:LV.0000/0000 /N.00000", "rg": "0000000000", "rgIssueState": "SP", "rgIssuingAuthority": "SSP-SP", "rgMask": "99.999.999-9", "via": "2ª via" } } ``` {% endtab %} {% endtabs %} --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://docs.caf.io/caf-api/caf-api-pt-br/connect/transactions/services/document-ocr.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.