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-09-18T12:48:21.7088369-03:00",
"TipoDeDocumentoID": "95ac2f2b-18bc-4765-b23c-54dcd33db901",
"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": "db246a33-0aed-416d-b0a5-75d4567a74b3",
"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": "150289ff-a636-46b9-84a4-ef04bece3f3a",
"Ordem": 2
},
{
"IndiceID": "150289ff-a636-46b9-84a4-ef04bece3f3a",
"Ordem": 2
}
]
},
{
"DadosModeloDePesquisa": [
{
"IndiceID": "150289ff-a636-46b9-84a4-ef04bece3f3a",
"Ordem": 2
},
{
"IndiceID": "150289ff-a636-46b9-84a4-ef04bece3f3a",
"Ordem": 2
}
]
}
],
"IndicesObject": [
{
"ID": "b98009e9-9f45-4dd5-ad7b-87d90670f607",
"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": "b98009e9-9f45-4dd5-ad7b-87d90670f607",
"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": "2eec071c-920f-450e-bc7b-12d7a39aeb2e",
"ValidationResult": {
"IsOK": true,
"Erros": [
"sample string 1",
"sample string 2"
],
"MessageSuccess": "sample string 2"
}
},
"CodigoDeBarras": [
{
"DocumentoID": "bbe39013-3e5c-48fc-b177-35fa1e9d1e87",
"Total": 2,
"Tipo": "sample string 3",
"Valor": "sample string 4",
"CheckSum": true,
"Angulo": 6.1,
"Pagina": 7,
"ID": "02e17419-b3e1-48fe-be89-219ee5c3db1b",
"ValidationResult": {
"IsOK": true,
"Erros": [
"sample string 1",
"sample string 2"
],
"MessageSuccess": "sample string 2"
}
},
{
"DocumentoID": "bbe39013-3e5c-48fc-b177-35fa1e9d1e87",
"Total": 2,
"Tipo": "sample string 3",
"Valor": "sample string 4",
"CheckSum": true,
"Angulo": 6.1,
"Pagina": 7,
"ID": "02e17419-b3e1-48fe-be89-219ee5c3db1b",
"ValidationResult": {
"IsOK": true,
"Erros": [
"sample string 1",
"sample string 2"
],
"MessageSuccess": "sample string 2"
}
}
],
"DocumentoItens": [
{
"DocumentoID": "a0abf371-9e21-49d4-a9dc-7421b24a269a",
"Nome": "sample string 2",
"Data": "2026-09-18T12:48:21.7088369-03:00",
"Pasta": "sample string 4",
"NomeDoUsuario": "sample string 5",
"ID": "c4c605ce-b553-4fb9-adf2-18efccb2ea78",
"ValidationResult": {
"IsOK": true,
"Erros": [
"sample string 1",
"sample string 2"
],
"MessageSuccess": "sample string 2"
}
},
{
"DocumentoID": "a0abf371-9e21-49d4-a9dc-7421b24a269a",
"Nome": "sample string 2",
"Data": "2026-09-18T12:48:21.7088369-03:00",
"Pasta": "sample string 4",
"NomeDoUsuario": "sample string 5",
"ID": "c4c605ce-b553-4fb9-adf2-18efccb2ea78",
"ValidationResult": {
"IsOK": true,
"Erros": [
"sample string 1",
"sample string 2"
],
"MessageSuccess": "sample string 2"
}
}
],
"Indices": [
{
"DocumentoID": "e86e1849-7157-427b-b4a8-f4417ba617b7",
"Chave": "sample string 2",
"Valor": "sample string 3",
"ID": "c11ca798-5172-4489-bde4-334cdd521c4c",
"ValidationResult": {
"IsOK": true,
"Erros": [
"sample string 1",
"sample string 2"
],
"MessageSuccess": "sample string 2"
}
},
{
"DocumentoID": "e86e1849-7157-427b-b4a8-f4417ba617b7",
"Chave": "sample string 2",
"Valor": "sample string 3",
"ID": "c11ca798-5172-4489-bde4-334cdd521c4c",
"ValidationResult": {
"IsOK": true,
"Erros": [
"sample string 1",
"sample string 2"
],
"MessageSuccess": "sample string 2"
}
}
],
"Hashes": [
{
"DocumentoID": "2e0c60bb-2ecd-4be6-bd78-cb24b0c21c41",
"Hash": "sample string 2",
"ID": "01b70eaf-8893-47f8-92f1-544489fb036c",
"ValidationResult": {
"IsOK": true,
"Erros": [
"sample string 1",
"sample string 2"
],
"MessageSuccess": "sample string 2"
}
},
{
"DocumentoID": "2e0c60bb-2ecd-4be6-bd78-cb24b0c21c41",
"Hash": "sample string 2",
"ID": "01b70eaf-8893-47f8-92f1-544489fb036c",
"ValidationResult": {
"IsOK": true,
"Erros": [
"sample string 1",
"sample string 2"
],
"MessageSuccess": "sample string 2"
}
}
],
"ID": "065f7168-a6a2-4272-9921-dc077f295e60",
"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>065f7168-a6a2-4272-9921-dc077f295e60</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>02e17419-b3e1-48fe-be89-219ee5c3db1b</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>bbe39013-3e5c-48fc-b177-35fa1e9d1e87</DocumentoID>
<Pagina>7</Pagina>
<Tipo>sample string 3</Tipo>
<Total>2</Total>
<Valor>sample string 4</Valor>
</LeituraCodigoDeBarras>
<LeituraCodigoDeBarras>
<ID>02e17419-b3e1-48fe-be89-219ee5c3db1b</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>bbe39013-3e5c-48fc-b177-35fa1e9d1e87</DocumentoID>
<Pagina>7</Pagina>
<Tipo>sample string 3</Tipo>
<Total>2</Total>
<Valor>sample string 4</Valor>
</LeituraCodigoDeBarras>
</CodigoDeBarras>
<DataDoCadastro>2026-09-18T12:48:21.7088369-03:00</DataDoCadastro>
<DocumentoItens>
<DocumentoItem>
<ID>c4c605ce-b553-4fb9-adf2-18efccb2ea78</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-09-18T12:48:21.7088369-03:00</Data>
<DocumentoID>a0abf371-9e21-49d4-a9dc-7421b24a269a</DocumentoID>
<Nome>sample string 2</Nome>
<NomeDoUsuario>sample string 5</NomeDoUsuario>
<Pasta>sample string 4</Pasta>
</DocumentoItem>
<DocumentoItem>
<ID>c4c605ce-b553-4fb9-adf2-18efccb2ea78</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-09-18T12:48:21.7088369-03:00</Data>
<DocumentoID>a0abf371-9e21-49d4-a9dc-7421b24a269a</DocumentoID>
<Nome>sample string 2</Nome>
<NomeDoUsuario>sample string 5</NomeDoUsuario>
<Pasta>sample string 4</Pasta>
</DocumentoItem>
</DocumentoItens>
<Hashes>
<DocumentoHash>
<ID>01b70eaf-8893-47f8-92f1-544489fb036c</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>2e0c60bb-2ecd-4be6-bd78-cb24b0c21c41</DocumentoID>
<Hash>sample string 2</Hash>
</DocumentoHash>
<DocumentoHash>
<ID>01b70eaf-8893-47f8-92f1-544489fb036c</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>2e0c60bb-2ecd-4be6-bd78-cb24b0c21c41</DocumentoID>
<Hash>sample string 2</Hash>
</DocumentoHash>
</Hashes>
<Indices>
<DocumentoIndice>
<ID>c11ca798-5172-4489-bde4-334cdd521c4c</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>e86e1849-7157-427b-b4a8-f4417ba617b7</DocumentoID>
<Valor>sample string 3</Valor>
</DocumentoIndice>
<DocumentoIndice>
<ID>c11ca798-5172-4489-bde4-334cdd521c4c</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>e86e1849-7157-427b-b4a8-f4417ba617b7</DocumentoID>
<Valor>sample string 3</Valor>
</DocumentoIndice>
</Indices>
<TextoOCR>sample string 1</TextoOCR>
<TipoDeDocumento>
<ID>2eec071c-920f-450e-bc7b-12d7a39aeb2e</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>db246a33-0aed-416d-b0a5-75d4567a74b3</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>b98009e9-9f45-4dd5-ad7b-87d90670f607</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>b98009e9-9f45-4dd5-ad7b-87d90670f607</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>150289ff-a636-46b9-84a4-ef04bece3f3a</IndiceID>
<Ordem>2</Ordem>
</DadosModeloDePesquisa>
<DadosModeloDePesquisa>
<IndiceID>150289ff-a636-46b9-84a4-ef04bece3f3a</IndiceID>
<Ordem>2</Ordem>
</DadosModeloDePesquisa>
</DadosModeloDePesquisa>
</TipoDeEscaneamentoModeloDePesquisa>
<TipoDeEscaneamentoModeloDePesquisa>
<DadosModeloDePesquisa>
<DadosModeloDePesquisa>
<IndiceID>150289ff-a636-46b9-84a4-ef04bece3f3a</IndiceID>
<Ordem>2</Ordem>
</DadosModeloDePesquisa>
<DadosModeloDePesquisa>
<IndiceID>150289ff-a636-46b9-84a4-ef04bece3f3a</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>95ac2f2b-18bc-4765-b23c-54dcd33db901</TipoDeDocumentoID>
</Documento>