GET api/Documento/PesquisarPeloNomeDaImagem?nomeDaImagem={nomeDaImagem}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| nomeDaImagem | string |
Required |
Body Parameters
None.
Response Information
Resource Description
Documento| Name | Description | Type | Additional information |
|---|---|---|---|
| TextoOCR | string |
None. |
|
| DataDoCadastro | date |
None. |
|
| TipoDeDocumentoID | globally unique identifier |
None. |
|
| TipoDeDocumento | TipoDeEscaneamento |
None. |
|
| CodigoDeBarras | Collection of LeituraCodigoDeBarras |
None. |
|
| DocumentoItens | Collection of DocumentoItem |
None. |
|
| Indices | Collection of DocumentoIndice |
None. |
|
| Hashes | Collection of DocumentoHash |
None. |
|
| ID | globally unique identifier |
None. |
|
| ValidationResult | ValidationResult |
None. |
Response Formats
application/json, text/json
Sample:
{
"TextoOCR": "sample string 1",
"DataDoCadastro": "2026-10-23T10:13:42.8685639-03:00",
"TipoDeDocumentoID": "37c97fc8-729d-4ecb-a8c8-7df489a47b56",
"TipoDeDocumento": {
"Nome": "sample string 1",
"FrenteEhVerso": true,
"AutoDesvio": true,
"RemoverBordasEscuras": true,
"PretoEhBranco": true,
"RemoverPontosIsolados": true,
"AutoBrilho": true,
"Rotacionar": 0,
"Area": "sample string 8",
"Brilho": 9,
"Contraste": 10,
"Resolucao": 11,
"Saturacao": 12,
"Gama": 13,
"TipoDeArquivo": 0,
"GerarOCR": true,
"LerCodigoDeBarras": true,
"AssinaturaDigital": true,
"ConfigurarDerivada": true,
"ExcluirPaginaEmBranco": true,
"AnotacaoID": "399a44f6-57fc-4454-8a56-abf45ff61353",
"TamanhoDoPapel": "sample string 20",
"Privado": true,
"GruposDeAcesso": "sample string 22",
"ConfiguracaoDeArmazenamento": "sample string 23",
"ConfiguracaoDaDerivada": "sample string 24",
"ModelosDePesquisa": "sample string 25",
"Indices": "sample string 26",
"NatoDigital": true,
"Modelo": "QEA=",
"ModeloAnotacao": "QEA=",
"AreaObject": {
"Esquerda": 1,
"Topo": 2,
"Tamanho": 3,
"Largura": 4
},
"ConfiguracaoDeArmazenamentoObject": {
"TipoDeArmazenamento": 0,
"CaminhoLocal": "sample string 1",
"UrlFTP": "sample string 2",
"UsuarioFTP": "sample string 3",
"SenhaFTP": "sample string 4",
"Conexao": "sample string 5"
},
"ConfiguracaoDaDerivadaObject": {
"PretoEhBranco": true,
"Resolucao": 2,
"TipoDeArquivo": 0,
"AssinaturaDigital": true
},
"ModelosDePesquisaObject": [
{
"DadosModeloDePesquisa": [
{
"IndiceID": "a790723e-97fd-4922-bdd1-f79bbd67f15b",
"Ordem": 2
},
{
"IndiceID": "a790723e-97fd-4922-bdd1-f79bbd67f15b",
"Ordem": 2
}
]
},
{
"DadosModeloDePesquisa": [
{
"IndiceID": "a790723e-97fd-4922-bdd1-f79bbd67f15b",
"Ordem": 2
},
{
"IndiceID": "a790723e-97fd-4922-bdd1-f79bbd67f15b",
"Ordem": 2
}
]
}
],
"IndicesObject": [
{
"ID": "567d390c-f4ad-4167-9deb-34f5ccd50291",
"Nome": "sample string 2",
"TipoDeControle": 0,
"Mascara": "sample string 3",
"Obrigatorio": true,
"TipoDeValidacao": 0,
"TamanhoDaColuna": "sample string 5",
"ColecaoID": "sample string 6",
"Unico": true,
"PesquisaContem": true
},
{
"ID": "567d390c-f4ad-4167-9deb-34f5ccd50291",
"Nome": "sample string 2",
"TipoDeControle": 0,
"Mascara": "sample string 3",
"Obrigatorio": true,
"TipoDeValidacao": 0,
"TamanhoDaColuna": "sample string 5",
"ColecaoID": "sample string 6",
"Unico": true,
"PesquisaContem": true
}
],
"ID": "d82fa632-795a-4df6-8342-8d5e9e364362",
"ValidationResult": {
"IsOK": true,
"Erros": [
"sample string 1",
"sample string 2"
],
"MessageSuccess": "sample string 2"
}
},
"CodigoDeBarras": [
{
"DocumentoID": "f9d63e8f-68b4-46f2-811c-86bba058512b",
"Total": 2,
"Tipo": "sample string 3",
"Valor": "sample string 4",
"CheckSum": true,
"Angulo": 6.1,
"Pagina": 7,
"ID": "182dc6e9-a3cd-4225-b6cf-8a2c000ecc88",
"ValidationResult": {
"IsOK": true,
"Erros": [
"sample string 1",
"sample string 2"
],
"MessageSuccess": "sample string 2"
}
},
{
"DocumentoID": "f9d63e8f-68b4-46f2-811c-86bba058512b",
"Total": 2,
"Tipo": "sample string 3",
"Valor": "sample string 4",
"CheckSum": true,
"Angulo": 6.1,
"Pagina": 7,
"ID": "182dc6e9-a3cd-4225-b6cf-8a2c000ecc88",
"ValidationResult": {
"IsOK": true,
"Erros": [
"sample string 1",
"sample string 2"
],
"MessageSuccess": "sample string 2"
}
}
],
"DocumentoItens": [
{
"DocumentoID": "95005a5f-db41-4644-84be-1e4ae2ac301d",
"Nome": "sample string 2",
"Data": "2026-10-23T10:13:42.8685639-03:00",
"Pasta": "sample string 4",
"NomeDoUsuario": "sample string 5",
"ID": "88281a4a-320c-4147-8cba-a18d4aee01f5",
"ValidationResult": {
"IsOK": true,
"Erros": [
"sample string 1",
"sample string 2"
],
"MessageSuccess": "sample string 2"
}
},
{
"DocumentoID": "95005a5f-db41-4644-84be-1e4ae2ac301d",
"Nome": "sample string 2",
"Data": "2026-10-23T10:13:42.8685639-03:00",
"Pasta": "sample string 4",
"NomeDoUsuario": "sample string 5",
"ID": "88281a4a-320c-4147-8cba-a18d4aee01f5",
"ValidationResult": {
"IsOK": true,
"Erros": [
"sample string 1",
"sample string 2"
],
"MessageSuccess": "sample string 2"
}
}
],
"Indices": [
{
"DocumentoID": "f42ba2af-88ea-442b-907b-d57830c57659",
"Chave": "sample string 2",
"Valor": "sample string 3",
"ID": "3d71359e-8678-498d-b8d8-340886c282ae",
"ValidationResult": {
"IsOK": true,
"Erros": [
"sample string 1",
"sample string 2"
],
"MessageSuccess": "sample string 2"
}
},
{
"DocumentoID": "f42ba2af-88ea-442b-907b-d57830c57659",
"Chave": "sample string 2",
"Valor": "sample string 3",
"ID": "3d71359e-8678-498d-b8d8-340886c282ae",
"ValidationResult": {
"IsOK": true,
"Erros": [
"sample string 1",
"sample string 2"
],
"MessageSuccess": "sample string 2"
}
}
],
"Hashes": [
{
"DocumentoID": "8bdf284c-e194-452d-ba67-4c145dd96b9b",
"Hash": "sample string 2",
"ID": "e176d1f2-afe2-4173-b600-3875da4068ad",
"ValidationResult": {
"IsOK": true,
"Erros": [
"sample string 1",
"sample string 2"
],
"MessageSuccess": "sample string 2"
}
},
{
"DocumentoID": "8bdf284c-e194-452d-ba67-4c145dd96b9b",
"Hash": "sample string 2",
"ID": "e176d1f2-afe2-4173-b600-3875da4068ad",
"ValidationResult": {
"IsOK": true,
"Erros": [
"sample string 1",
"sample string 2"
],
"MessageSuccess": "sample string 2"
}
}
],
"ID": "525338de-8b92-400b-b5b8-bb2487860a47",
"ValidationResult": {
"IsOK": true,
"Erros": [
"sample string 1",
"sample string 2"
],
"MessageSuccess": "sample string 2"
}
}
application/xml, text/xml
Sample:
<Documento xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/rift.doctus.model">
<ID>525338de-8b92-400b-b5b8-bb2487860a47</ID>
<ValidationResult>
<Erros xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:string>sample string 1</d3p1:string>
<d3p1:string>sample string 2</d3p1:string>
</Erros>
<IsOK>true</IsOK>
<MessageSuccess>sample string 2</MessageSuccess>
</ValidationResult>
<CodigoDeBarras>
<LeituraCodigoDeBarras>
<ID>182dc6e9-a3cd-4225-b6cf-8a2c000ecc88</ID>
<ValidationResult>
<Erros xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:string>sample string 1</d5p1:string>
<d5p1:string>sample string 2</d5p1:string>
</Erros>
<IsOK>true</IsOK>
<MessageSuccess>sample string 2</MessageSuccess>
</ValidationResult>
<Angulo>6.1</Angulo>
<CheckSum>true</CheckSum>
<DocumentoID>f9d63e8f-68b4-46f2-811c-86bba058512b</DocumentoID>
<Pagina>7</Pagina>
<Tipo>sample string 3</Tipo>
<Total>2</Total>
<Valor>sample string 4</Valor>
</LeituraCodigoDeBarras>
<LeituraCodigoDeBarras>
<ID>182dc6e9-a3cd-4225-b6cf-8a2c000ecc88</ID>
<ValidationResult>
<Erros xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:string>sample string 1</d5p1:string>
<d5p1:string>sample string 2</d5p1:string>
</Erros>
<IsOK>true</IsOK>
<MessageSuccess>sample string 2</MessageSuccess>
</ValidationResult>
<Angulo>6.1</Angulo>
<CheckSum>true</CheckSum>
<DocumentoID>f9d63e8f-68b4-46f2-811c-86bba058512b</DocumentoID>
<Pagina>7</Pagina>
<Tipo>sample string 3</Tipo>
<Total>2</Total>
<Valor>sample string 4</Valor>
</LeituraCodigoDeBarras>
</CodigoDeBarras>
<DataDoCadastro>2026-10-23T10:13:42.8685639-03:00</DataDoCadastro>
<DocumentoItens>
<DocumentoItem>
<ID>88281a4a-320c-4147-8cba-a18d4aee01f5</ID>
<ValidationResult>
<Erros xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:string>sample string 1</d5p1:string>
<d5p1:string>sample string 2</d5p1:string>
</Erros>
<IsOK>true</IsOK>
<MessageSuccess>sample string 2</MessageSuccess>
</ValidationResult>
<Data>2026-10-23T10:13:42.8685639-03:00</Data>
<DocumentoID>95005a5f-db41-4644-84be-1e4ae2ac301d</DocumentoID>
<Nome>sample string 2</Nome>
<NomeDoUsuario>sample string 5</NomeDoUsuario>
<Pasta>sample string 4</Pasta>
</DocumentoItem>
<DocumentoItem>
<ID>88281a4a-320c-4147-8cba-a18d4aee01f5</ID>
<ValidationResult>
<Erros xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:string>sample string 1</d5p1:string>
<d5p1:string>sample string 2</d5p1:string>
</Erros>
<IsOK>true</IsOK>
<MessageSuccess>sample string 2</MessageSuccess>
</ValidationResult>
<Data>2026-10-23T10:13:42.8685639-03:00</Data>
<DocumentoID>95005a5f-db41-4644-84be-1e4ae2ac301d</DocumentoID>
<Nome>sample string 2</Nome>
<NomeDoUsuario>sample string 5</NomeDoUsuario>
<Pasta>sample string 4</Pasta>
</DocumentoItem>
</DocumentoItens>
<Hashes>
<DocumentoHash>
<ID>e176d1f2-afe2-4173-b600-3875da4068ad</ID>
<ValidationResult>
<Erros xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:string>sample string 1</d5p1:string>
<d5p1:string>sample string 2</d5p1:string>
</Erros>
<IsOK>true</IsOK>
<MessageSuccess>sample string 2</MessageSuccess>
</ValidationResult>
<DocumentoID>8bdf284c-e194-452d-ba67-4c145dd96b9b</DocumentoID>
<Hash>sample string 2</Hash>
</DocumentoHash>
<DocumentoHash>
<ID>e176d1f2-afe2-4173-b600-3875da4068ad</ID>
<ValidationResult>
<Erros xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:string>sample string 1</d5p1:string>
<d5p1:string>sample string 2</d5p1:string>
</Erros>
<IsOK>true</IsOK>
<MessageSuccess>sample string 2</MessageSuccess>
</ValidationResult>
<DocumentoID>8bdf284c-e194-452d-ba67-4c145dd96b9b</DocumentoID>
<Hash>sample string 2</Hash>
</DocumentoHash>
</Hashes>
<Indices>
<DocumentoIndice>
<ID>3d71359e-8678-498d-b8d8-340886c282ae</ID>
<ValidationResult>
<Erros xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:string>sample string 1</d5p1:string>
<d5p1:string>sample string 2</d5p1:string>
</Erros>
<IsOK>true</IsOK>
<MessageSuccess>sample string 2</MessageSuccess>
</ValidationResult>
<Chave>sample string 2</Chave>
<DocumentoID>f42ba2af-88ea-442b-907b-d57830c57659</DocumentoID>
<Valor>sample string 3</Valor>
</DocumentoIndice>
<DocumentoIndice>
<ID>3d71359e-8678-498d-b8d8-340886c282ae</ID>
<ValidationResult>
<Erros xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:string>sample string 1</d5p1:string>
<d5p1:string>sample string 2</d5p1:string>
</Erros>
<IsOK>true</IsOK>
<MessageSuccess>sample string 2</MessageSuccess>
</ValidationResult>
<Chave>sample string 2</Chave>
<DocumentoID>f42ba2af-88ea-442b-907b-d57830c57659</DocumentoID>
<Valor>sample string 3</Valor>
</DocumentoIndice>
</Indices>
<TextoOCR>sample string 1</TextoOCR>
<TipoDeDocumento>
<ID>d82fa632-795a-4df6-8342-8d5e9e364362</ID>
<ValidationResult>
<Erros xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:string>sample string 1</d4p1:string>
<d4p1:string>sample string 2</d4p1:string>
</Erros>
<IsOK>true</IsOK>
<MessageSuccess>sample string 2</MessageSuccess>
</ValidationResult>
<AnotacaoID>399a44f6-57fc-4454-8a56-abf45ff61353</AnotacaoID>
<Area>sample string 8</Area>
<AreaObject>
<Esquerda>1</Esquerda>
<Largura>4</Largura>
<Tamanho>3</Tamanho>
<Topo>2</Topo>
</AreaObject>
<AssinaturaDigital>true</AssinaturaDigital>
<AutoBrilho>true</AutoBrilho>
<AutoDesvio>true</AutoDesvio>
<Brilho>9</Brilho>
<ConfiguracaoDaDerivada>sample string 24</ConfiguracaoDaDerivada>
<ConfiguracaoDaDerivadaObject>
<AssinaturaDigital>true</AssinaturaDigital>
<PretoEhBranco>true</PretoEhBranco>
<Resolucao>2</Resolucao>
<TipoDeArquivo>JPEG</TipoDeArquivo>
</ConfiguracaoDaDerivadaObject>
<ConfiguracaoDeArmazenamento>sample string 23</ConfiguracaoDeArmazenamento>
<ConfiguracaoDeArmazenamentoObject>
<CaminhoLocal>sample string 1</CaminhoLocal>
<Conexao>sample string 5</Conexao>
<SenhaFTP>sample string 4</SenhaFTP>
<TipoDeArmazenamento>Local</TipoDeArmazenamento>
<UrlFTP>sample string 2</UrlFTP>
<UsuarioFTP>sample string 3</UsuarioFTP>
</ConfiguracaoDeArmazenamentoObject>
<ConfigurarDerivada>true</ConfigurarDerivada>
<Contraste>10</Contraste>
<ExcluirPaginaEmBranco>true</ExcluirPaginaEmBranco>
<FrenteEhVerso>true</FrenteEhVerso>
<Gama>13</Gama>
<GerarOCR>true</GerarOCR>
<GruposDeAcesso>sample string 22</GruposDeAcesso>
<Indices>sample string 26</Indices>
<IndicesObject>
<TipoDeEscaneamentoIndice>
<ColecaoID>sample string 6</ColecaoID>
<ID>567d390c-f4ad-4167-9deb-34f5ccd50291</ID>
<Mascara>sample string 3</Mascara>
<Nome>sample string 2</Nome>
<Obrigatorio>true</Obrigatorio>
<PesquisaContem>true</PesquisaContem>
<TamanhoDaColuna>sample string 5</TamanhoDaColuna>
<TipoDeControle>TEXTO</TipoDeControle>
<TipoDeValidacao>Nenhum</TipoDeValidacao>
<Unico>true</Unico>
</TipoDeEscaneamentoIndice>
<TipoDeEscaneamentoIndice>
<ColecaoID>sample string 6</ColecaoID>
<ID>567d390c-f4ad-4167-9deb-34f5ccd50291</ID>
<Mascara>sample string 3</Mascara>
<Nome>sample string 2</Nome>
<Obrigatorio>true</Obrigatorio>
<PesquisaContem>true</PesquisaContem>
<TamanhoDaColuna>sample string 5</TamanhoDaColuna>
<TipoDeControle>TEXTO</TipoDeControle>
<TipoDeValidacao>Nenhum</TipoDeValidacao>
<Unico>true</Unico>
</TipoDeEscaneamentoIndice>
</IndicesObject>
<LerCodigoDeBarras>true</LerCodigoDeBarras>
<Modelo>QEA=</Modelo>
<ModeloAnotacao>QEA=</ModeloAnotacao>
<ModelosDePesquisa>sample string 25</ModelosDePesquisa>
<ModelosDePesquisaObject>
<TipoDeEscaneamentoModeloDePesquisa>
<DadosModeloDePesquisa>
<DadosModeloDePesquisa>
<IndiceID>a790723e-97fd-4922-bdd1-f79bbd67f15b</IndiceID>
<Ordem>2</Ordem>
</DadosModeloDePesquisa>
<DadosModeloDePesquisa>
<IndiceID>a790723e-97fd-4922-bdd1-f79bbd67f15b</IndiceID>
<Ordem>2</Ordem>
</DadosModeloDePesquisa>
</DadosModeloDePesquisa>
</TipoDeEscaneamentoModeloDePesquisa>
<TipoDeEscaneamentoModeloDePesquisa>
<DadosModeloDePesquisa>
<DadosModeloDePesquisa>
<IndiceID>a790723e-97fd-4922-bdd1-f79bbd67f15b</IndiceID>
<Ordem>2</Ordem>
</DadosModeloDePesquisa>
<DadosModeloDePesquisa>
<IndiceID>a790723e-97fd-4922-bdd1-f79bbd67f15b</IndiceID>
<Ordem>2</Ordem>
</DadosModeloDePesquisa>
</DadosModeloDePesquisa>
</TipoDeEscaneamentoModeloDePesquisa>
</ModelosDePesquisaObject>
<NatoDigital>true</NatoDigital>
<Nome>sample string 1</Nome>
<PretoEhBranco>true</PretoEhBranco>
<Privado>true</Privado>
<RemoverBordasEscuras>true</RemoverBordasEscuras>
<RemoverPontosIsolados>true</RemoverPontosIsolados>
<Resolucao>11</Resolucao>
<Rotacionar>RotateNoneFlipNone</Rotacionar>
<Saturacao>12</Saturacao>
<TamanhoDoPapel>sample string 20</TamanhoDoPapel>
<TipoDeArquivo>JPEG</TipoDeArquivo>
</TipoDeDocumento>
<TipoDeDocumentoID>37c97fc8-729d-4ecb-a8c8-7df489a47b56</TipoDeDocumentoID>
</Documento>