GET api/Documento/ObterPeloId/{id}

Request Information

URI Parameters

Name	Description	Type	Additional information
id		globally unique identifier	Required

Body Parameters

None.

Response Information

Resource Description

Documento

Name	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": "2025-12-06T01:00:39.4883676-03:00",
  "TipoDeDocumentoID": "6c431673-8f17-4237-ba51-7cc8a38c3dfb",
  "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": "3c9886bb-9b0d-482b-866c-28a309c5b83b",
    "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": "2f32b99f-eb24-421e-8b30-11821e5effe9",
            "Ordem": 2
          },
          {
            "IndiceID": "2f32b99f-eb24-421e-8b30-11821e5effe9",
            "Ordem": 2
          }
        ]
      },
      {
        "DadosModeloDePesquisa": [
          {
            "IndiceID": "2f32b99f-eb24-421e-8b30-11821e5effe9",
            "Ordem": 2
          },
          {
            "IndiceID": "2f32b99f-eb24-421e-8b30-11821e5effe9",
            "Ordem": 2
          }
        ]
      }
    ],
    "IndicesObject": [
      {
        "ID": "8cd3b7af-e51f-4bb1-92fa-bdbcdfec02e4",
        "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": "8cd3b7af-e51f-4bb1-92fa-bdbcdfec02e4",
        "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": "5fd621b7-6564-4854-86e4-84366bbaa089",
    "ValidationResult": {
      "IsOK": true,
      "Erros": [
        "sample string 1",
        "sample string 2"
      ],
      "MessageSuccess": "sample string 2"
    }
  },
  "CodigoDeBarras": [
    {
      "DocumentoID": "abe6c98c-0d25-443d-bd3b-017a00bb05e9",
      "Total": 2,
      "Tipo": "sample string 3",
      "Valor": "sample string 4",
      "CheckSum": true,
      "Angulo": 6.1,
      "Pagina": 7,
      "ID": "502713c9-77d8-4c0a-aab4-41a090a92765",
      "ValidationResult": {
        "IsOK": true,
        "Erros": [
          "sample string 1",
          "sample string 2"
        ],
        "MessageSuccess": "sample string 2"
      }
    },
    {
      "DocumentoID": "abe6c98c-0d25-443d-bd3b-017a00bb05e9",
      "Total": 2,
      "Tipo": "sample string 3",
      "Valor": "sample string 4",
      "CheckSum": true,
      "Angulo": 6.1,
      "Pagina": 7,
      "ID": "502713c9-77d8-4c0a-aab4-41a090a92765",
      "ValidationResult": {
        "IsOK": true,
        "Erros": [
          "sample string 1",
          "sample string 2"
        ],
        "MessageSuccess": "sample string 2"
      }
    }
  ],
  "DocumentoItens": [
    {
      "DocumentoID": "e3a8d386-9d7d-45ab-a291-393f74c5f085",
      "Nome": "sample string 2",
      "Data": "2025-12-06T01:00:39.4883676-03:00",
      "Pasta": "sample string 4",
      "NomeDoUsuario": "sample string 5",
      "ID": "a3cd2863-ba57-4350-91a6-a0adc9ac74e9",
      "ValidationResult": {
        "IsOK": true,
        "Erros": [
          "sample string 1",
          "sample string 2"
        ],
        "MessageSuccess": "sample string 2"
      }
    },
    {
      "DocumentoID": "e3a8d386-9d7d-45ab-a291-393f74c5f085",
      "Nome": "sample string 2",
      "Data": "2025-12-06T01:00:39.4883676-03:00",
      "Pasta": "sample string 4",
      "NomeDoUsuario": "sample string 5",
      "ID": "a3cd2863-ba57-4350-91a6-a0adc9ac74e9",
      "ValidationResult": {
        "IsOK": true,
        "Erros": [
          "sample string 1",
          "sample string 2"
        ],
        "MessageSuccess": "sample string 2"
      }
    }
  ],
  "Indices": [
    {
      "DocumentoID": "17052f9a-a711-4736-8d2d-d55b60be30fe",
      "Chave": "sample string 2",
      "Valor": "sample string 3",
      "ID": "fb7442b9-751a-49c0-9227-86b9a3377377",
      "ValidationResult": {
        "IsOK": true,
        "Erros": [
          "sample string 1",
          "sample string 2"
        ],
        "MessageSuccess": "sample string 2"
      }
    },
    {
      "DocumentoID": "17052f9a-a711-4736-8d2d-d55b60be30fe",
      "Chave": "sample string 2",
      "Valor": "sample string 3",
      "ID": "fb7442b9-751a-49c0-9227-86b9a3377377",
      "ValidationResult": {
        "IsOK": true,
        "Erros": [
          "sample string 1",
          "sample string 2"
        ],
        "MessageSuccess": "sample string 2"
      }
    }
  ],
  "Hashes": [
    {
      "DocumentoID": "47ca343d-e61c-4492-9799-753831deda06",
      "Hash": "sample string 2",
      "ID": "eba0fc4e-3812-4223-b4cf-18fe79feeea3",
      "ValidationResult": {
        "IsOK": true,
        "Erros": [
          "sample string 1",
          "sample string 2"
        ],
        "MessageSuccess": "sample string 2"
      }
    },
    {
      "DocumentoID": "47ca343d-e61c-4492-9799-753831deda06",
      "Hash": "sample string 2",
      "ID": "eba0fc4e-3812-4223-b4cf-18fe79feeea3",
      "ValidationResult": {
        "IsOK": true,
        "Erros": [
          "sample string 1",
          "sample string 2"
        ],
        "MessageSuccess": "sample string 2"
      }
    }
  ],
  "ID": "a8f44ac0-5f55-4fcc-833a-9d2afcde2a16",
  "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>a8f44ac0-5f55-4fcc-833a-9d2afcde2a16</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>502713c9-77d8-4c0a-aab4-41a090a92765</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>abe6c98c-0d25-443d-bd3b-017a00bb05e9</DocumentoID>
      <Pagina>7</Pagina>
      <Tipo>sample string 3</Tipo>
      <Total>2</Total>
      <Valor>sample string 4</Valor>
    </LeituraCodigoDeBarras>
    <LeituraCodigoDeBarras>
      <ID>502713c9-77d8-4c0a-aab4-41a090a92765</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>abe6c98c-0d25-443d-bd3b-017a00bb05e9</DocumentoID>
      <Pagina>7</Pagina>
      <Tipo>sample string 3</Tipo>
      <Total>2</Total>
      <Valor>sample string 4</Valor>
    </LeituraCodigoDeBarras>
  </CodigoDeBarras>
  <DataDoCadastro>2025-12-06T01:00:39.4883676-03:00</DataDoCadastro>
  <DocumentoItens>
    <DocumentoItem>
      <ID>a3cd2863-ba57-4350-91a6-a0adc9ac74e9</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>2025-12-06T01:00:39.4883676-03:00</Data>
      <DocumentoID>e3a8d386-9d7d-45ab-a291-393f74c5f085</DocumentoID>
      <Nome>sample string 2</Nome>
      <NomeDoUsuario>sample string 5</NomeDoUsuario>
      <Pasta>sample string 4</Pasta>
    </DocumentoItem>
    <DocumentoItem>
      <ID>a3cd2863-ba57-4350-91a6-a0adc9ac74e9</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>2025-12-06T01:00:39.4883676-03:00</Data>
      <DocumentoID>e3a8d386-9d7d-45ab-a291-393f74c5f085</DocumentoID>
      <Nome>sample string 2</Nome>
      <NomeDoUsuario>sample string 5</NomeDoUsuario>
      <Pasta>sample string 4</Pasta>
    </DocumentoItem>
  </DocumentoItens>
  <Hashes>
    <DocumentoHash>
      <ID>eba0fc4e-3812-4223-b4cf-18fe79feeea3</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>47ca343d-e61c-4492-9799-753831deda06</DocumentoID>
      <Hash>sample string 2</Hash>
    </DocumentoHash>
    <DocumentoHash>
      <ID>eba0fc4e-3812-4223-b4cf-18fe79feeea3</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>47ca343d-e61c-4492-9799-753831deda06</DocumentoID>
      <Hash>sample string 2</Hash>
    </DocumentoHash>
  </Hashes>
  <Indices>
    <DocumentoIndice>
      <ID>fb7442b9-751a-49c0-9227-86b9a3377377</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>17052f9a-a711-4736-8d2d-d55b60be30fe</DocumentoID>
      <Valor>sample string 3</Valor>
    </DocumentoIndice>
    <DocumentoIndice>
      <ID>fb7442b9-751a-49c0-9227-86b9a3377377</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>17052f9a-a711-4736-8d2d-d55b60be30fe</DocumentoID>
      <Valor>sample string 3</Valor>
    </DocumentoIndice>
  </Indices>
  <TextoOCR>sample string 1</TextoOCR>
  <TipoDeDocumento>
    <ID>5fd621b7-6564-4854-86e4-84366bbaa089</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>3c9886bb-9b0d-482b-866c-28a309c5b83b</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>8cd3b7af-e51f-4bb1-92fa-bdbcdfec02e4</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>8cd3b7af-e51f-4bb1-92fa-bdbcdfec02e4</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>2f32b99f-eb24-421e-8b30-11821e5effe9</IndiceID>
            <Ordem>2</Ordem>
          </DadosModeloDePesquisa>
          <DadosModeloDePesquisa>
            <IndiceID>2f32b99f-eb24-421e-8b30-11821e5effe9</IndiceID>
            <Ordem>2</Ordem>
          </DadosModeloDePesquisa>
        </DadosModeloDePesquisa>
      </TipoDeEscaneamentoModeloDePesquisa>
      <TipoDeEscaneamentoModeloDePesquisa>
        <DadosModeloDePesquisa>
          <DadosModeloDePesquisa>
            <IndiceID>2f32b99f-eb24-421e-8b30-11821e5effe9</IndiceID>
            <Ordem>2</Ordem>
          </DadosModeloDePesquisa>
          <DadosModeloDePesquisa>
            <IndiceID>2f32b99f-eb24-421e-8b30-11821e5effe9</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>6c431673-8f17-4237-ba51-7cc8a38c3dfb</TipoDeDocumentoID>
</Documento>