Classificar Documento

Método para classificação automática de documentos. `Para esse método é o envio do Token de Autenticação do usuário`

Seu principal objetivo é o processamento do documento através de OCR e reconhecimento de padrões para identificação do tipo.

Os principais tipos documentais processados são:

`RG, CNH ou Carteira de Identidade Profissional - TODAS AS MODALIDADES`

`CPF (situação cadastral retirada do site da Receita Federal)`

`Cert. de Nascimento, Casamento ou Averbação de divórcio`

`Certificado e Histórico do Ensino Médio`

`Diploma de Graduação, Certificado de Pós-Graduação`

`Histórico de Graduação Completo`

Esse método é necessário o envio do token que deverá ser enviado em todas as APIs Ex. `Authentication: Bearer + token gerado`

URL EndPoint Homologação: `https://hom_documentos.alunodigital.com.br/ClassifyDocumentBase64`
URL EndPoint Producao: `https://documentos.alunodigital.com.br/ClassifyDocumentBase64`

Request (Envio)

Parameter	Type	Position	#	Description
chaveCliente	`string`	`Body`	`Required`	Chave de Identificação do Cliente
file	`string`	`Body`	`Required`	Documento a ser processado, o envio deve ser em Base64
extension	`string`	`Body`	`Optional`	Extensão do arquivo enviado, Ex. ".pdf"
classificationType	`string`	`Body`	`Optional`	Tipo esperado, pode ser enviado o tipo do documento que acha que pode ser. Dessa forma o processamento vai comparar se o tipo enviado e o tipo processado são o mesmo
name	`string`	`Body`	`Optional`	Nome, pode ser enviado o nome da pessoa a qual pertence o documento. Dessa forma o processamento vai verificar se esse nome contem dentro do documento identificado se esse documento é dessa mesma pessoa
cpf	`string`	`Body`	`Optional`	CPF, pode ser enviado o CPF da pessoa a qual pertence o documento. Dessa forma o processamento vai verificar se esse CPF contem dentro do documento identificado se esse documento é dessa mesma pessoa
rg	`string`	`Body`	`Optional`	RG, pode ser enviado o RG da pessoa a qual pertence o documento. Dessa forma o processamento vai verificar se esse RG contem dentro do documento identificado se esse documento é dessa mesma pessoa

Exemplo do Json de Envio

{
   "chaveCliente": "string",
   "file": "string",
   "extension": "string",
   "classificationType": "string",
   "name": "string",
   "cpf": "string",
   "rg": "string"
}

Response (retorno)

Parameter	Type	Position	#	Description
transactionId	`string`	`Body`	`#`	ID da Transação efetuada no sistema
hashDocument	`string`	`Body`	`#`	Hash do documento enviado
success	`bool`	`Body`	`#`	Resultado Principal, se true ou false para o processamento do documento
message	`string`	`Body`	`#`	Retorna uma mensagem quando dá algum tipo de erro no processamento, Ex: "O envio do documento é obrigatório." ou "Documento já enviado para processamento!"
data
matchDocumentType	`bool`	`Body`	`#`	retorna "true" ou "false" quando é passado o tipo do documento no campo "classificationType" nos parametros de entrada. O processamento vai comparar o tipo enviado com o tipo reconhecido e verifica se são os mesmo tipo documental.
documentTypeMessagem	`string`	`Body`	`#`	Ao comparar os tipos enviados e processados, devolve "Tipo Documental válido" ou "Tipo Documental inválido"
matchNameCompare	`string`	`Body`	`#`	retorna "true" ou "false" quando é passado o nome da pessoa no campo "name" nos parametros de entrada. O processamento vai comparar o nome enviado com o nome reconhecido e verifica se são da mesma pessoa.
nameMessagem	`string`	`Body`	`#`	Ao comparar o nome enviado com o nome processado, devolve "Nome no Documento válido" ou "Nome no Documento inválido"
matchCpfCompare	`string`	`Body`	`#`	retorna "true" ou "false" quando é passado o CPF da pessoa no campo "cpf" nos parametros de entrada. O processamento vai procurar o CPF enviado nos dados reconhecidos do documento e verifica se são da mesma pessoa.
cpfMessagem	`string`	`Body`	`#`	Ao comparar o CPF enviado, devolve "CPF no Documento válido" ou "CPF no Documento Inválido ou não localizado"
matchRgCompare	`string`	`Body`	`#`	retorna "true" ou "false" quando é passado o RG da pessoa no campo "rg" nos parametros de entrada. O processamento vai procurar o RG enviado nos dados reconhecidos do documento e verifica se são da mesma pessoa.
rgMessagem	`string`	`Body`	`#`	Ao comparar o RG enviado, devolve "RG no Documento válido" ou "RG no Documento Inválido ou não localizado"
objectDoc
nome	`string`	`Body`	`#`	Retorno o nome da pessoa que esta no documento processado.
tipo	`string`	`Body`	`#`	Retorno o Tipo do Documento que foi reconhecido.
rg	`string`	`Body`	`#`	Retorno o RG da pessoa que esta no documento processado.
cpf	`string`	`Body`	`#`	Retorno o CPF da pessoa que esta no documento processado.
filiacaO1	`string`	`Body`	`#`	Retorno o nome do pai ou o nome da mãe da pessoa que esta no documento processado.
filiacaO2	`string`	`Body`	`#`	Retorno o nome do pai ou o nome da mãe da pessoa que esta no documento processado.
dataexpedicao	`string`	`Body`	`#`	Retorno a possível data de expedição do documento processado.
datanascimento	`string`	`Body`	`#`	Retorno a data de nascimento da pessoal do documento processado.
naturalidade	`string`	`Body`	`#`	Retorno o local da naturalidade da pessoa do documento processado.
extractions
person: nameRequest	`string`	`Body`	`#`	Dados enviados: Nome Enviado no parâmetro "name"
person: nameResponse	`string`	`Body`	`#`	Dados Extraído do documento: Nome recuperado no processadomento do documento
classification: typeRequest	`string`	`Body`	`#`	Dados enviados: Classificação do Documento enviado no parâmetro "classificationType"
typeRequest: typeResponse	`string`	`Body`	`#`	Dados Extraído do documento: Classificação recuperado no processadomento do documento
textExtractionList: textExtraction	`string`	`Body`	`#`	Conteúdo reconhecido do documento enviado através de processamento por OCR (RECONHECIMENTO AUTOMÁTICO DE CARACTERES)
erros
error	`string`	`Body`	`#`	Erros não tratados ou outros erros de processamento do documento

Exemplo do Json de Retorno

{
   "transactionId": "64624cfa-3a6c-4cbb-929d-505eef1b151b",
   "hashDocument": "69a5b45df192fa33e302c530d964d5c0ace332d579183aa34b64cbce09314a0b",
   "success": true,
   "message": [],
   "data": {
	"matchDocumentType": false,
	"documentTypeMessagem": null,
	"matchNameCompare": false,
	"nameMessagem": null,
	"matchCpfCompare": false,
	"cpfMessagem": null,
	"matchRgCompare": false,
	"rgMessagem": null,
	"objectDoc": {
		"nome": "JOÃO GOMES DA COSTA",
		"tipo": "CERTIDÃO DE NASCIMENTO",
		"rg": "",
		"cpf": "98765456225",
		"filiacaO1": "FRANCISCA MARIA DA COSTA",
		"filiacaO2": "JOSE FRANCISCO GOMES",
		"dataexpedicao": "15/02/2023",
		"datanascimento": "17/11/1999",
		"naturalidade": ""
	},
	"extractions": [
		{
			"person": {
				"nameRequest": "",
				"nameResponse": "JOÃO GOMES DA COSTA"
			},
			"classification": {
				"confidences": null,
				"typeRequest": "",
				"typeResponse": "CERTIDÃO DE NASCIMENTO"
			},
			"textExtractionList": {
				"textExtraction": "CONTEÚDO DO DOCUMENTO ENVIADO RECONHECIDO POR OCR (RECONHECIMENTO AUTOMÁTICO DE CARACTERES)"
			}
		}
	]
 },
 "erros": {
 	"error": []
 }
 }